Errors

Errors come back as JSON with a code for your program and a message for the developer reading the logs.

{
  "error": {
    "code": "invalid_request",
    "message": "surfaces[0] needs either brand and code, or hex."
  }
}

invalid_request400

Something in the request is missing or wrong. The message says what.

missing_api_key401

The Authorization header is absent.

invalid_api_key401

The key is mistyped or has been revoked.

quota_exceeded402

The monthly allowance is used up.

plan_required403

The account is not on the Business plan.

not_found404

No preview with that id belongs to your account.

conflict409

The preview is not in the right state yet, such as upscaling one that is still processing.

concurrency_limit429

Three previews are already in progress. Wait for one to finish.

rate_limited429

Too many requests. Wait for the number of seconds in the Retry-After header.

internal_error500

Something went wrong on our side. The request is safe to retry.