DocumentationAPI Reference
ApiAPI ReferenceDocuments

List documents (paginated)

Lists documents belonging to the account, newest first. Requires the documents:read scope.

GET
/documents

Lists documents belonging to the account, newest first. 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.

Query Parameters

page?integer

Page number, 1-based. Defaults to 1.

Range1 <= value
Default1
limit?integer

Items per page. Defaults to 20, maximum 100.

Range1 <= value <= 100
Default20

Response Body

A page of documents.

application/json
  1. response
success*boolean
data*
error*
meta?
Example Request
curl -X GET 'https://outriskai.com/api/public/v1/documents'
Example Response
{  "success": true,  "data": {    "documents": [      {        "id": "string",        "title": "string",        "status": "pending",        "uploaded_at": "2019-08-24T14:15:22Z"      }    ]  },  "error": {},  "meta": {    "pagination": {      "page": 0,      "limit": 0,      "total": 0    }  }}

Account associated with the API key GET

Returns the account that owns the API key used for the request. Use it to verify credentials before starting longer workflows.

Upload or register a document for analysis POST

Registers a contract for analysis. Provide either a public HTTPS URL or a multipart file upload. The document is copied into OutRiskAI storage at submission time and analysis is queued in the background, so the response returns immediately. Requires the documents:write scope.