Skip to content

Restricted pilot. The API reference is generated from the running API. Successful matches return manual_review until attack detection is validated.

Errors

Every error has the same shape, and the request_id is what to quote to support.

error
{
  "code": "quota_exceeded",
  "message": "The verification quota for this billing period is used up.",
  "request_id": "req_01m...",
  "details": { "quota": 20000 }
}
HTTPcodeMeaning
400invalid_image_count, identity_requiredThe request is wrong
401unauthorizedMissing or invalid key or token
403insufficient_scope, account_inactiveValid key, not allowed
404not_foundAbsent, or belongs to someone else
409session_already_used, identity_exists, too_many_framesConflicts with current state
410session_expiredThe session has ended
413, 415image_too_large, unsupported_media_typeThe file was refused
422validation_error, corrupt_image, too_few_good_imagesValid shape, unusable content
429rate_limited, quota_exceeded, identity_limit_reachedSlow down, or a limit was reached
503overloaded, engine_unavailable, uploads_busyRetry after the delay