Document Artifacts Download
Download a stream of a single artifact.
GET documents/:documentId/artifacts/:artifactId?pageId=:pageId&contentType=:contentType
Request details
The response will be the binary stream of an artifact.
Request properties
| Property | Type | Description | Optional |
|---|---|---|---|
| DocumentId | guid | Unique identifier of the document. | No |
| ArtifactId | guid | Unique identifier of the artifact. | No |
| PageId | int | Index to return a specific page index. Must be between one(1) and the artifact page count. If the contentType is set to image/jpeg the pageId is mandatory |
Yes |
| ContentType | string | Artifact content type, possible values are application/pdf, image/jpeg, text/plain. |
No |
Example request
Download an image visualization from a specific artifact.
/documents/71fc0742-6f68-49db-a84b-b047312310133/artifacts/c5a12s654-282d-452a-ba2a-7058a3558707?pageId=1&contentType=image/jpeg
Download the PDF file from a specific artifact.
/documents/71fc0742-6f68-49db-a84b-b047312310133/artifacts/c5a12s654-282d-452a-ba2a-7058a3558707?contentType=application/pdf
Download a OCR Text file result from a specific artifact.
/documents/71fc0742-6f68-49db-a84b-b047312310133/artifacts/c5a12s654-282d-452a-ba2a-7058a3558707?contentType=text/plain
Possible error responses
| Status code | Error code | Details |
|---|---|---|
| 400 | validation_error | 'Content Type' must not be empty. |
| 400 | validation_error | Page id must be great or equal to 1 |
| 400 | validation_error | Page id must be provide when the content type is set to an image |