DocumentationAPI Reference
ApiAPI ReferenceDocuments

Processing status

Reports background analysis progress. Poll this endpoint until the status is completed or failed, then read the analysis. Requires the documents:read scope.

GET
/documents/{documentId}/status

Reports background analysis progress. Poll this endpoint until the status is completed or failed, then read the analysis. Requires the documents:read scope.

Authorization

bearerAuth
headerAuthorizationBearer <API Key>

An OutRiskAI API key, sent as a bearer token. Create keys in the dashboard under Settings; the secret is shown only once.

Path Parameters

documentId*string

Document identifier returned when the document is submitted.

Response Body

Current processing state.

application/json
  1. response
success*boolean
data*
error*
Example Request
curl -X GET 'https://outriskai.com/api/public/v1/documents/string/status'
Example Response
{  "success": true,  "data": {    "processing": {      "job_id": "string",      "status": "queued",      "current_step": 0,      "attempts": 0,      "error_message": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  },  "error": {}}

Delete a document DELETE

Permanently removes a document owned by the authenticated account, together with its analysis results. Requires the documents:write scope.

Risk analysis results GET

Returns the generated summary, identified risks and suggested solutions. Available once the processing status is completed. Requires the documents:read scope.