API Reference
Interactive OpenAPI reference for OutRiskAI public endpoints, request schemas, and response formats
The OutRiskAI API reference is generated automatically from our OpenAPI 3.1 schema. Browse every operation below, view full request and response parameters, and execute live test calls directly from your browser.
Base Path: /api/public/v1
Auth Header: Authorization: Bearer ork_live_<your_key>
Rate Limit: 100 requests per 15 minutes
General Endpoints
Service health checking and account verification.
GET /health
Check system status and current API deployment version (Unauthenticated).
GET /account
Inspect account details, email, and organization for the authenticated key.
Document & Risk Analysis Endpoints
Submit contracts, monitor background processing, and retrieve extracted legal risks.
GET /documents
List uploaded contract documents with pagination (page, limit).
POST /documents
Submit a contract document file or register a public URL for AI risk analysis.
GET /documents/{documentId}
Fetch metadata, title, and file properties for a specific document.
DELETE /documents/{documentId}
Permanently delete a contract document and its associated analysis results.
GET /documents/{documentId}/status
Poll real-time background processing status (queued, processing, completed, failed).
GET /documents/{documentId}/analysis
Retrieve the completed AI risk summary, detected clauses, risk levels, and mitigation solutions.
Authentication
All operations (except GET /health) require your secret key sent as a Bearer token:
Authorization: Bearer ork_live_<your_secret_key>Keys are created under your Profile page (/profile) in the API Credentials section.
Standard Error Codes
| Status | Code | Description |
|---|---|---|
400 | validation_error | Parameter or body validation error. |
401 | unauthorized | Missing, malformed, or revoked API key. |
403 | forbidden | API key lacks required scope (documents:read or documents:write). |
404 | not_found | Resource does not exist or belongs to another organization. |
409 | conflict | Idempotency key payload mismatch or active request in flight. |
413 | payload_too_large | Document size exceeds 20 MB limit. |
415 | unsupported_media_type | File byte header is not a valid PDF, PNG, or JPEG. |
429 | rate_limited | Quota exceeded (100 req / 15 min). Check Retry-After header. |
500 | internal_error | Unexpected server error. |