Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clear-box.io/llms.txt

Use this file to discover all available pages before exploring further.

ClearBox returns errors as JSON with a stable code, a human-readable message, and an HTTP status.
{
  "error": {
    "code": "insufficient_balance",
    "message": "Wallet available balance is below the requested amount.",
    "doc_url": "https://docs.clearbox.example.com/reference/errors"
  }
}

Common error codes

CodeHTTPMeaning
unauthorized401Missing or invalid API key.
identity_not_verified403The identity has not passed ClearCheck.
insufficient_balance402The wallet’s available balance is too low.
limit_exceeded422The request exceeds a compliance or spend limit.
not_found404The referenced object does not exist.
rate_limited429Too many requests; retry with backoff.
Always branch on code, not on message (messages may change).