Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.katalo.ai/llms.txt

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

The API uses standard HTTP status codes and returns a normalized JSON error envelope for failures.

​
Error envelope

{
  "error": {
    "code": "validation_error",
    "message": "Request fields failed validation.",
    "retryable": false,
    "retry_after": null
  }
}

​
HTTP status codes

StatusCodeMeaningRetry?
400bad_requestMalformed JSON, invalid multipart, or mutually exclusive source inputs.No
401unauthorizedMissing or malformed bearer token.No
403forbiddenAPI access is disabled or the key does not belong to an approved organization.No
404not_foundThe requested job, source asset, or page does not exist for the caller.No
409idempotency_conflictThe same Idempotency-Key was reused with a different payload.No
422validation_errorRequest fields fail the workflow and capture-type validation matrix.No
429rate_limitedPer-key, per-org, or per-IP limit exceeded.Yes
500internal_errorUnexpected server-side failure.Yes

​
Handling failures

  • Treat authentication and validation failures as terminal until the request or access model is fixed.
  • Retry 429 only after the advertised retry window.
  • Retry retryable 5xx failures with backoff.
  • Keep the same idempotency key when retrying the same write request.