Skip to main content
POST
/
upload
curl --request POST \
  --url https://api.capout.ai/upload \
  --header 'Content-Type: application/json' \
  --header 'capout-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com/claims/123/scope.pdf",
  "file_name": "claim-123-scope.pdf",
  "xn_address": "restoration-team@example.xn"
}
'
{
  "document_id": "doc_123",
  "workflow_id": "wf_123",
  "status": "processing",
  "created_at": "2026-04-14T14:30:00Z",
  "status_url": "/status/doc_123",
  "ws_url": "/ws/status"
}

Authorizations

​
capout-api-key
string
header
default:capout_test_your_api_key
required

Organization-scoped API key used for REST endpoints and for minting realtime tokens.

Body

application/json

Request body for POST /upload. Provide exactly one of url or file_base64. Inline file_base64 uploads are supported up to 50 MB.

​
file_base64
string | null
required

Base64-encoded PDF file. Inline uploads are supported up to 50 MB.

Example:

"JVBERi0xLjQKJ..."

​
file_name
string
required

Original filename.

Example:

"claim-123-scope.pdf"

​
xn_address
string
required

Xactnet recipient address for this upload.

Example:

"restoration-team@example.xn"

​
url
string | null

Fetchable HTTPS URL to a PDF that the server can retrieve immediately.

Example:

"https://example.com/claims/123/scope.pdf"

Response

Successful response

Response body for POST /upload.

​
document_id
string
required
Example:

"doc_123"

​
created_at
string<date-time>
required
Example:

"2026-04-14T14:30:00Z"

​
status_url
string
required
Example:

"/status/doc_123"

​
workflow_id
string | null
Example:

"wf_123"

​
status
string
default:processing
Example:

"processing"

​
ws_url
string
default:/ws/status
Example:

"/ws/status"