Errors & retries

HTTP errors return error.code, a safe error.message and a requestId. Include the request ID when contacting support.

HTTP	Action
400 / 413 / 415 / 422	Correct the request, file size or file type before retrying.
401 / 403	Check the API key, required scope and organization access.
404	Check the ID. Resources outside your organization also return 404.
409	Inspect the error code: a conflicting key, incomplete result or invalid job state needs a different action.
410	The upload or result expired. An expired upload needs a new upload and key; an expired result is no longer available.
429 / 503	Inspect the code. For temporary capacity errors, honor Retry-After and add backoff with jitter. Insufficient allowance requires capacity to become available.

Example error · Invalid API key

{
  "error": {
    "code": "invalid_api_key",
    "message": "The supplied API key is invalid.",
    "requestId": "req_example"
  }
}

Example response · Failed job (illustrative excerpt)

{
  "id": "rev_example",
  "status": "failed",
  "error": {
    "code": "provider_rate_limited",
    "message": "The review could not complete. No review units were charged.",
    "retryScheduled": false,
    "reviewUnitsChargedMilli": 0
  }
}

A processing failure is reported on the job, not as an HTTP failure of the status request. Stop on failed. After resolving its cause, submit a new review with a new key if appropriate.