List document fragments
GET/pipelines/:pipeline_id/documents/:document_id/fragments
Returns one page of the fragments of one document version, in the order of the fragments within the version. The version is the latest current version of the document, or the latest version created at or before as_of that had not expired at that time. An expired document returns HTTP 404 unless the request sets include_expired=true, which also considers expired versions. The fragment text is included in page_content only when the request sets contents=true.
Permissions. Read and execute on the pipeline, and a classification allow-list that covers the document's classification.
Documents, versions and fragments describes fragments, and API conventions describes pagination.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
The body is one page of fragments in the list envelope. page_content is present only with contents=true.
A query parameter is invalid: as_of lies outside the range of valid timestamps (Invalid version), order_by names another field (Invalid order_by parameter) or the pagination parameters conflict or request a page size outside 1 to 1000 (Pagination error).
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The key's classification allow-list for the pipeline does not cover the document's classification (Unauthorized: <permissions> access to Pipeline required).
No pipeline with this identifier exists or the key lacks read and execute permission on the pipeline (Pipeline not found), or the pipeline has no matching version of the document, for example because the document has expired and the request does not set include_expired=true (Document not found). Each message carries the identifier in details.id.
The text of a fragment could not be decrypted (Internal server error). Only a request with contents=true decrypts text. The API server log records the cause.