Documents

Read one document’s record

The document’s own record: title, type, direction, extracted fields with their confidence, retention date, legal hold, and the current file — and untrusted_summary, two or three lines on what the document is, which answers «what is this document?» without reading its text (null until processed). detailed adds the version history and the processing state. This is the RECORD, not the text — for the content use documents_get_content.

Examples

  • Show me that invoice GET /api/v1/rest/documents/11111111-2222-4333-8444-555555555555?response_format=detailed
get/api/v1/rest/documents/{id}

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/documents/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The document id, from a search result.

Query parameters

response_format'concise' | 'detailed'

concise (default) returns the fields you need to answer a question; detailed adds related records and costs more context.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

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