Documents
List existing proofs with pagination and filters
GET
https://backend.immut.io/api/v1/documentsRequired scope: documents:read
Parameters
| Name | In | Required | Description |
|---|---|---|---|
workspace | query | no | workspace id |
folder | query | no | folder id |
category | query | no | document category |
blockchainStatus | query | no | proof status |
uploadChannel | query | no | web | api | agent. Use agent to see only what the agent protected |
docType | query | no | agent classification doc type |
docState | query | no | agent classification doc state |
runId | query | no | only documents protected by this sweep |
objective | query | no | the objective the agent was working to |
folderKey | query | no | the folder key the agent chose |
servesObjective | query | no | true | false |
needsFolder | query | no | true returns agent-protected files still sitting at the workspace root |
minConfidence | query | no | 0 to 1 |
maxConfidence | query | no | 0 to 1 |
minFolderConfidence | query | no | 0 to 1, the filing confidence rather than the classification confidence |
maxFolderConfidence | query | no | 0 to 1 |
from | query | no | ISO 8601, filters on when the document was protected |
to | query | no | ISO 8601, filters on when the document was protected |
search | query | no | matches file name, title and the agent reason |
page | query | no | default 1 |
limit | query | no | default 20, max 100 |
Responses
| Status | Meaning |
|---|---|
200 | Paginated proof list with meta { page, limit, total } Returns: each row is the document including its full agentClassification: docType, docState, servesObjective, folderKey, confidence, folderConfidence, reason, objective, runId. meta carries page, limit, total, totalPages. |
Example
curl -X GET "https://backend.immut.io/api/v1/documents" \
-H "Authorization: Bearer $IMMUT_API_KEY"
Generated from the immut API contract, version 1.14.0. Machine-readable: this page as markdown · everything in one file · OpenAPI