Skip to main content
CapOut processing calls return quickly with a document_id. After that, use one of the status tools until the export is complete or failed.

​
capout_document_status

Use this for a one-shot status check.

​
capout_wait_for_document

Use this when you want the agent UI to wait and stream progress for a bounded window.
Never send max_wait_ms above 110000. If one wait window ends and the document is still in progress, call capout_wait_for_document again immediately.

​
Example output

Both tools return a terminal-friendly export panel instead of raw JSON. A completed export looks like:
The successful output uses stable CapOut links. It must not expose the temporary signed S3 URL behind either redirect or embed an API key in a link.

​
Terminal state

Treat the workflow as finished when the returned panel indicates a terminal result. For successful runs, expect:
  • STATUS: COMPLETE
  • Terminal : YES
  • Workflow Complete : YES
  • Contractor and Carrier URLs plus the capout-api-key header requirement
An explicit Terminal : NO is authoritative even if an upstream stage already reports workflow completion. Keep calling one of these tools until the durable result is terminal. When it completes, give the user the friendly download URLs and authentication guidance directly; do not merely say that processing finished.