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.

​
Endpoint map

​
Upload

  • POST /upload: submit one PDF for processing

​
Status

  • GET /status/{document_id}: poll one document
  • GET /documents: list documents submitted by the authenticated organization

​
Credits

  • GET /credits: inspect the current organization 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.