Find other files in the space that share entities with this one

GET

/spaces/:spaceId/ontology/files/:fileId/related

GET

/spaces/:spaceId/ontology/files/:fileId/related

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

200Retrieved

1 {
2   "files": [
3     {
4       "fileId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "score": 5,
6       "shared": [
7         {
8           "entityId": "org-12345",
9           "name": "Acme Corporation",
10           "type": "organization"
11         },
12         {
13           "entityId": "loc-67890",
14           "name": "New York City",
15           "type": "location"
16         }
17       ]
18     },
19     {
20       "fileId": "f0e1d2c3-b4a5-6789-0abc-def123456789",
21       "score": 3,
22       "shared": [
23         {
24           "entityId": "org-12345",
25           "name": "Acme Corporation",
26           "type": "organization"
27         }
28       ]
29     }
30   ]
31 }

Returns { files } — documents in the same space connected to :fileId through shared entities, ranked by score (more or rarer shared entities score higher). Each item has fileId, score, and shared (the overlapping entities as { entityId, name, type }). Use it for ‘documents related to this one’. Requires space:read on :spaceId; missing access surfaces as a 404.

Returns `{ files }` — documents in the same space connected to `:fileId` through shared entities, ranked by `score` (more or rarer shared entities score higher). Each item has `fileId`, `score`, and `shared` (the overlapping entities as `{ entityId, name, type }`). Use it for 'documents related to this one'. 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

Related files ranked by shared-entity overlap.

fileslist of objects