Read one document’s record (status)
Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.
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/status?response_format=detailed
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/documents/{id}/status
- Auth: HTTP bearer
Path parameters
The document id, from a search result.
Query parameters
concise (default) returns the fields you need to answer a question; detailed adds related records and costs more context.
Headers
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.
Changes
No recorded changes to this operation across all 1 revision of this API.