# CapOut API

- [CapOut API](https://docs.capout.ai/index.md): Upload insurance PDFs through REST or MCP, track status, stream updates, and monitor claims.
- [Quickstart](https://docs.capout.ai/quickstart.md): Go from API key to downloadable Contractor and Carrier ESX files.
- [Authentication](https://docs.capout.ai/authentication.md): Use API keys for REST requests and short-lived tokens for realtime subscriptions.
- [Upload a Document](https://docs.capout.ai/guides/upload-a-document.md): Send a document by URL or inline base64 for ESX generation and track it with the returned document ID.
- [Download ESX Files](https://docs.capout.ai/guides/download-esx.md): Give users stable CapOut links for Contractor and Carrier ESX files without storing expiring S3 signatures.
- [Realtime Updates](https://docs.capout.ai/guides/realtime-updates.md): Stream document status changes with WebSocket or Server-Sent Events.
- [Claims and Usage](https://docs.capout.ai/guides/claims-and-usage.md): Read organization claim balances and interpret expiring buckets.
- [MCP Installation](https://docs.capout.ai/mcp/installation.md): Connect CapOut MCP from Codex, Claude Code, Gemini CLI, OpenCode, GitHub Copilot CLI, and agent installers using each client's documented remote MCP setup flow.
- [CapOut MCP](https://docs.capout.ai/mcp/overview.md): Use CapOut from ChatGPT, Claude, Codex, and other MCP-aware clients to process PDFs, track exports, and receive stable ESX download links.
- [Process PDFs](https://docs.capout.ai/mcp/tools/process-pdf.md): Use capout_process_pdf to generate Contractor and Carrier ESX files from one PDF.
- [Staged Uploads](https://docs.capout.ai/mcp/tools/staged-uploads.md): Use capout_create_upload_url and capout_process_staged_upload for local PDFs because the CapOut MCP is hosted remotely.
- [Status and Waiting](https://docs.capout.ai/mcp/tools/status-and-waiting.md): Use capout_document_status and capout_wait_for_document to follow ESX generation until it reaches a terminal state.
- [Claims](https://docs.capout.ai/mcp/tools/claims.md): Use capout_claims to inspect the authenticated organization's remaining CapOut claims.
- [XactNet Addresses](https://docs.capout.ai/mcp/tools/xactnet-addresses.md): Manage saved XactNet or Xactimate recipient addresses retained for compatibility with older CapOut workflows.
- [API Keys](https://docs.capout.ai/mcp/tools/api-keys.md): Use capout_api_keys and capout_select_api_key to inspect or switch the active CapOut key for MCP traffic.
- [API Reference Overview](https://docs.capout.ai/api-reference/overview.md): Endpoint map, auth model, and the fastest route to the generated reference pages.
- [Upload Document](https://docs.capout.ai/api-reference/upload/upload-document.md): Upload a PDF document for processing.
- [Get Document Status](https://docs.capout.ai/api-reference/status/get-document-status.md): Get the current processing status of a document (one-shot poll).
- [List Documents](https://docs.capout.ai/api-reference/status/list-documents.md): List all API-submitted documents for the authenticated organization.
- [Download Esx](https://docs.capout.ai/api-reference/esx-downloads/download-esx.md): Authorize an organization and redirect to a freshly signed ESX object. Re-downloading an existing export, selecting either profile, or refreshing an expired signed URL does not consume another claim. Use the document_id returned by upload and a key for the document organization.
- [Get Claims](https://docs.capout.ai/api-reference/claims/get-claims.md): Check claim balance for the authenticated organization.
- [Create Realtime Ws Token](https://docs.capout.ai/api-reference/websocket/create-realtime-ws-token.md): Mint a short-lived realtime token for WebSocket or SSE authentication.
- [Sse Status](https://docs.capout.ai/api-reference/sse/sse-status.md): SSE endpoint for streaming one or more documents' status updates.

## OpenAPI Specs

- [openapi](/openapi.json)