Download Document Content
This API allows a caller to download the original file of a preserved PDI (Package of Digital Information) by its document ID.
Why This API Exists​
Once documents have been ingested and preserved in the TS Archive, it is sometimes necessary to retrieve the original file. This API exists so that consumers can download the raw binary content of a stored document using its unique identifier. The response is streamed as a file (application/octet-stream) or as JSON metadata depending on the Accept header.
Use Cases​
Use this API when you need to:
- Download the original preserved file associated with a specific PDI.
- Verify the content of a document that has been archived.
- Serve the original file to an end-user or external system.
How to Use the API​
Endpoint​
GET /api/v3/archive/pdi/{documentId}/content
Authentication​
Authentication is required. Refer to the Authentication page for how to obtain and use a valid JWT token.
Allowed security roles: User
Headers​
All standard headers are required for this request. Refer to the Standard Headers page for the full list and their descriptions.
In addition to the standard headers documentId header is required. It identifies the unique ID of the document whose content is to be downloaded and is provided as a path parameter in the endpoint: /api/v3/archive/pdi/{documentId}/content.
Responses​
200 OK — Original file returned​
The original stored file is returned as raw binary data
Media type: application/octet-stream / application/json
The response body contains the raw file content as a binary stream when the Accept header is set to application/octet-stream.
400 Bad Request​
One or more parameters provided in the request are incorrect, or required parameters are missing.
{
"timestamp": "2026-02-25T08:22:41.550Z",
"status": "CONTINUE",
"code": "string",
"message": "string"
}
401 Unauthorized​
The provided credentials are not correct.
{
"timestamp": "2026-02-25T08:22:41.551Z",
"status": "CONTINUE",
"code": "string",
"message": "string"
}
403 Forbidden​
The authenticated caller does not have the required permissions to perform this operation.
{
"timestamp": "2026-02-25T08:22:41.552Z",
"status": "CONTINUE",
"code": "string",
"message": "string"
}
API Reference​
Use the links below to open the interactive OpenAPI (Swagger) documentation for this endpoint in each environment.