POST/v1/files/{id}/analyze

Analyse a document

Send one document to the analysis engine, or re-run it: records a queued analysis at the next attempt number and queues the hand-off. Reach for it when a single document was re-uploaded or came back unreadable; processing every document on a deal is the record-level process route instead. Refuses with 409 while an analysis of that document is already queued or running.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyobjectoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "attemptNo": 1,
    "failureReason": "string",
    "fileId": "",
    "fileName": "string",
    "finishedAt": "string",
    "handoff": "string",
    "id": "",
    "jobId": "",
    "requestedAt": "string",
    "requestedBy": 1,
    "rowId": "",
    "startedAt": "string",
    "status": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired