Get a space’s entity/relation knowledge graph

GET

/spaces/:spaceId/ontology

GET

/spaces/:spaceId/ontology

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

200Retrieved

1 {
2   "entities": [
3     {
4       "id": "ent-12345",
5       "type": "organization",
6       "name": "Acme Inc",
7       "key": "acme_inc",
8       "mentionCount": 42
9     },
10     {
11       "id": "ent-67890",
12       "type": "person",
13       "name": "Jane Doe",
14       "key": "jane_doe",
15       "mentionCount": 15
16     },
17     {
18       "id": "ent-54321",
19       "type": "location",
20       "name": "New York City",
21       "key": "new_york_city",
22       "mentionCount": 27
23     }
24   ],
25   "edges": [
26     {
27       "sourceId": "ent-67890",
28       "targetId": "ent-12345",
29       "relation": "employed_by",
30       "fileId": "file-98765"
31     },
32     {
33       "sourceId": "ent-12345",
34       "targetId": "ent-54321",
35       "relation": "headquartered_in",
36       "fileId": "file-98765"
37     }
38   ]
39 }

Returns the whole knowledge graph extracted from the documents in a space: { entities, edges }. Each entity has id, type (one of organization | person | location | identifier | date | amount | other), name, key, and mentionCount; each edge has sourceId, targetId, relation, and the fileId it was observed in. Optional ?limit= (1-2000) caps the number of entities returned. Requires space:read on :spaceId — a caller lacking it gets a 404 (existence is hidden).

Returns the whole knowledge graph extracted from the documents in a space: `{ entities, edges }`. Each entity has `id`, `type` (one of organization | person | location | identifier | date | amount | other), `name`, `key`, and `mentionCount`; each edge has `sourceId`, `targetId`, `relation`, and the `fileId` it was observed in. Optional `?limit=` (1-2000) caps the number of entities returned. Requires `space:read` on `:spaceId` — a caller lacking it gets a 404 (existence is hidden).

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

Query parameters

limitintegerOptional1-2000Defaults to 500

Maximum entities returned, 1–2000. Defaults to 500. There is no cursor.

Response

The space graph.

entitieslist of objects

edgeslist of objects