# CapOut API

## Docs

- [Get credits](https://docs.capout.ai/api-reference/credits/get-credits.md): Check the credit balance for the authenticated organization.
- [API Reference Overview](https://docs.capout.ai/api-reference/overview.md): Endpoint map, auth model, and the fastest route to the generated reference pages.
- [SSE status stream](https://docs.capout.ai/api-reference/sse/sse-status-stream.md): SSE endpoint for streaming one or more documents' status updates.
- [Get document status](https://docs.capout.ai/api-reference/status/get-document-status.md): Get the current workflow status of a document with a one-shot poll.
- [List documents](https://docs.capout.ai/api-reference/status/list-documents.md): List all API-submitted documents for the authenticated organization.
- [Upload document](https://docs.capout.ai/api-reference/upload/upload-document.md): Upload a PDF document for automatic Xactimate export by sending either a fetchable `url` or inline `file_base64` content.
- [Create realtime token](https://docs.capout.ai/api-reference/websocket/create-realtime-token.md): Mint a short-lived realtime token for WebSocket or SSE authentication.
- [Authentication](https://docs.capout.ai/authentication.md): Use API keys for REST requests and short-lived tokens for realtime subscriptions.
- [Credits and Usage](https://docs.capout.ai/guides/credits-and-usage.md): Read organization credit balances and interpret expiring buckets.
- [Realtime Updates](https://docs.capout.ai/guides/realtime-updates.md): Stream document status changes with WebSocket or Server-Sent Events.
- [Upload a Document](https://docs.capout.ai/guides/upload-a-document.md): Send a document by URL or inline base64 for automatic Xactimate export and track it with the returned document ID.
- [CapOut API](https://docs.capout.ai/index.md): Upload insurance PDFs through REST or MCP, track status, stream updates, and monitor credits.
- [MCP Installation](https://docs.capout.ai/mcp/installation.md): Connect CapOut MCP from Codex, Claude Code, Gemini CLI, OpenCode, and GitHub Copilot CLI 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, manage recipients, and track export progress.
- [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.
- [Credits](https://docs.capout.ai/mcp/tools/credits.md): Use capout_credits to inspect the authenticated organization's remaining CapOut credits.
- [Process PDFs](https://docs.capout.ai/mcp/tools/process-pdf.md): Use capout_process_pdf to send one PDF into the CapOut export workflow.
- [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 an export until it reaches a terminal state.
- [XactNet Addresses](https://docs.capout.ai/mcp/tools/xactnet-addresses.md): List, save, and delete saved XactNet or Xactimate recipient addresses through the CapOut MCP.
- [Quickstart](https://docs.capout.ai/quickstart.md): Go from API key to automatic Xactimate export.

## OpenAPI Specs

- [openapi](https://docs.capout.ai/openapi.json)