Documents
Read a protected document back, decrypted
GET
https://backend.immut.io/api/v1/documents/{id}/contentRequired scope: documents:content
Use it to review a file you did not classify at upload time, for example one a person uploaded through the web app, then describe it with PATCH /documents/{id}/classification. Requires the documents:content scope, which is NOT granted to agent keys by default: an admin adds it deliberately, because it is the difference between a key that can see metadata and one that can read documents. Staged files are not readable here. The connector is hosted, so bytes travel through immut to your model host.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | id of the target record |
Responses
| Status | Meaning |
|---|---|
200 | The decrypted file bytes, streamed with its own content type. |
400 | BadRequest |
401 | Unauthorized |
403 | Forbidden |
429 | RateLimited |
Example
curl -X GET "https://backend.immut.io/api/v1/documents/<id>/content" \
-H "Authorization: Bearer $IMMUT_API_KEY"
Generated from the immut API contract, version 1.10.0. Machine-readable: this page as markdown · everything in one file · OpenAPI