Documents

List a document's relations

Returns the typed edges this document asserts about others, oldest first. An edge is owned by the document it leaves, so this is what the document claims — use ?related_to= on the listing to find what claims something about it.

get/v1/projects/{project_id}/documents/{document_id}/relations

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/documents/{document_id}/relations
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Path parameters

document_idstring required
Example:doc_V1StGXR8Z5jdHi6B

Query parameters

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

offsetinteger

Results to skip. Negative or not an integer it is 400.

Response

The document's relations, oldest first

totalinteger required
limitinteger required
offsetinteger required

Example response

{
  "data": [
    {
      "id": "doc_rel_V1StGXR8Z5jdHi6B",
      "type": "cites",
      "from_document_id": "doc_V1StGXR8Z5jdHi6B",
      "to_document_id": "doc_9Kp2mQxZ7bT4rN6W"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.