Skip to main content

Errors

Most API failures return a JSON body shaped like:
{
  "error": "error_code",
  "detail": "Optional detail"
}

Common gateway errors

  • missing_api_key: no API key was provided to a compute endpoint.
  • invalid_api_key: the provided key does not match an active account.
  • account_inactive: the account is not active.
  • insufficient_credits: the account does not meet the minimum credit policy.
  • rate_limited: per-account rate limit exceeded.
  • request_too_large: request body exceeded the configured maximum.
  • queue_full: the concurrency queue is full.
  • queue_timeout: the request waited too long in queue.
  • upstream_failed: the model server request failed.

Common model-server errors

  • model_name is not allowed.
  • detector_backend is not allowed.
  • distance_metric must be cosine, euclidean, or euclidean_l2.
  • missing image input: ...

Debugging tips

  • Capture x-request-id for every failed request.
  • Check GET /capabilities when a model or detector becomes unavailable.
  • Re-run with a single known-good image pair before escalating compare issues.