Get a document
GET/pipelines/:pipeline_id/documents/:document_id
Returns the latest current version of a document in a pipeline, with the processing status in the status field. A client application retrieves the document after adding the document to find out when processing ends with success, failed or canceled. as_of returns the version that was current at a given time, and include_expired=true also considers expired versions, so an expired document returns HTTP 404 without the parameter.
Permissions. Read on the pipeline, and a classification allow-list that covers the document's classification.
Documents, versions and fragments describes the processing lifecycle and point-in-time reads.
Request
Responses
- 200
- 400
- 401
- 403
- 404
The body is the document version.
The as_of value lies outside the range of valid timestamps (Invalid version).
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The pipeline exists, and the key lacks read permission on the pipeline or the key's classification allow-list does not cover the document's classification (Unauthorized: read access to Pipeline required, with the reason in details.error for a classification).
No pipeline with this identifier exists (Pipeline not found), or the pipeline has no matching version of the document (Document not found). Each message carries the identifier in details.id.