Base endpoints
- REST:
https://api.capout.ai - WebSocket status stream:
wss://api.capout.ai/ws/status - SSE status stream:
https://api.capout.ai/sse/status
Core workflow
- Send
capout-api-keyon REST requests. - Upload a PDF with
POST /upload. - Poll
GET /status/{document_id}or subscribe to realtime updates. - Read credit balances with
GET /credits.
Start here
- Quickstart for the shortest end-to-end path.
- Authentication for API key and realtime token behavior.
- Upload a document for request design and upload tradeoffs.
- Realtime updates for WebSocket and SSE examples.
- API reference overview for the full endpoint map.
What the API covers
Uploads
Submit a PDF either by passing a publicurl or by sending file_base64. Every accepted upload returns a document_id you can track immediately.
Status tracking
UseGET /status/{document_id} when polling a single job, or GET /documents when you need the authenticated organization’s recent uploads.
Realtime delivery
CallPOST /ws/token to mint a short-lived token, then connect over WebSocket or SSE using that token as a query parameter.
Credits
UseGET /credits to see the current organization balance plus any buckets that expire soon.