API documentation | API docs for agents | OpenAPI 3.1

analyze

ark.analyze_billing_document

Analyze Billing Document through the authoritative Billing application boundary.

Availability: Expanded preview
Scopes: billing:write
ARK permissions: canViewBillingcanMakeAdjustments
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

documentIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Stable key for safe replay of this exact operation input.; min length: 8; max length: 200

Request body

valueobjectrequired

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/documents/<documentId>/analyze' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.resultobjectrequired

Durable document-analysis job and queue state.

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry