List the entities extracted from one file, within a space

GET

/spaces/:spaceId/ontology/files/:fileId/entities

GET

/spaces/:spaceId/ontology/files/:fileId/entities

$ curl https://api.cloudraker.com/spaces/spaceId/ontology/files/fileId/entities \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entities": [
3     {
4       "id": "org-12345",
5       "type": "organization",
6       "name": "Acme Corporation",
7       "mentions": [
8         {
9           "page": 2,
10           "bbox": {
11             "x": 0.15,
12             "y": 0.3,
13             "width": 0.4,
14             "height": 0.1
15           },
16           "text": "Acme Corporation",
17           "startSeconds": null,
18           "endSeconds": null,
19           "speaker": null
20         },
21         {
22           "page": null,
23           "bbox": null,
24           "text": "Acme Corp",
25           "startSeconds": 12.5,
26           "endSeconds": 13.2,
27           "speaker": "Speaker 1"
28         }
29       ]
30     }
31   ]
32 }

Returns { entities } — every entity the given :fileId contributes to the space graph, with its id, type, name, and the file-local mentions (each with page + bbox for documents or startSeconds/endSeconds/speaker for audio, null where inapplicable). Entities are limited to those seen in this document. Requires space:read on :spaceId; missing access surfaces as a 404.

Returns `{ entities }` — every entity the given `:fileId` contributes to the space graph, with its `id`, `type`, `name`, and the file-local `mentions` (each with `page` + `bbox` for documents or `startSeconds`/`endSeconds`/`speaker` for audio, `null` where inapplicable). Entities are limited to those seen in this document. Requires `space:read` on `:spaceId`; missing access surfaces as a 404.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

fileIdstringRequired

Response

The file’s entities with their in-file grounded mentions.

entitieslist of objects