Skip to main content
Base URL: https://api.capout.ai

​
Auth model

  • REST endpoints use the capout-api-key header.
  • Realtime streams use a short-lived token minted from POST /ws/token.
  • GET /{document_id}.esx uses capout-api-key and only authorizes documents in that key’s organization.

​
Endpoint map

​
Upload

  • POST /upload: submit one PDF to generate Contractor and Carrier ESX files
The response includes stable Contractor and Carrier download URLs. New integrations should omit the optional, deprecated xn_address and profile_code compatibility fields.

​
Status

  • GET /status/{document_id}: poll one document’s workflow state
  • GET /documents: list documents submitted by the authenticated organization
Both status endpoints include the stable download links when export metadata is available.

​
ESX downloads

  • GET /{document_id}.esx: download Contractor (8D) by default
  • GET /{document_id}.esx?profile=contractor: explicitly download Contractor (8D)
  • GET /{document_id}.esx?profile=carrier: download Carrier (5L)
The authenticated route returns 404 for unknown or cross-organization documents and 409 until the export is ready. When ready, it returns a non-cached 307 to a freshly signed private S3 URL. Store the clean CapOut URL, not the redirected URL, and send capout-api-key with every request.

​
Claims

  • GET /claims: inspect the current organization claim balance

​
Realtime

  • POST /ws/token: mint a short-lived realtime token
  • GET /sse/status: subscribe over SSE
  • wss://api.capout.ai/ws/status: subscribe over WebSocket after minting a token

​
How to use this section

Use the generated endpoint pages in the sidebar for request schemas, examples, and the interactive playground. The guides in the Documentation tab cover the recommended integration flow around those endpoints.