Docs

Errors

When a capture fails, the API returns a JSON object with a machine-readable error code and a descriptive error message, and the HTTP status code indicates the type of the error:

{
  "error_code": "invalid_options",
  "error_message": "One or more options are invalid.",
  "errors": [
    {
      "option": "url",
      "message": "The \"url\" option is required."
    }
  ]
}

The errors array is only present for invalid_options.

Error codes

Error codeError messageHTTP statusWhat to do
access_key_requiredAn access key is required.401Send your access key. See Authentication.
access_key_invalidThe provided access key is invalid.401Check that the access key is on the API Keys page and that you copied all of it.
subscription_inactiveNo active subscription for the current period.403Check your plan on the Billing page.
monthly_quota_exhaustedMonthly quota exhausted. Upgrade your plan or wait until the next billing cycle.429Upgrade your plan on the Billing page, or wait for the number of seconds in the Retry-After header.
rpm_limit_exceededRate limit exceeded (requests per minute). Please retry after a short delay.429Retry after the number of seconds in the Retry-After header.
invalid_optionsOne or more options are invalid.400The errors array names each invalid option and explains what's wrong with it.
country_not_allowedYour plan does not allow the country parameter.403Upgrade to a paid plan, or use your own proxy instead.
signature_requiredGET: A valid signature is required for this API key.
POST: This API key requires signed requests, and only GET requests can be signed. Send a signed GET request, or use a separate API key without Require signed requests for POST requests.
403See Signed Requests.
signature_invalidThe provided signature is invalid.403See Signed Requests.
storage_endpoint_requiredstorage_endpoint is required when storage_mode=external.400Set storage_endpoint, or configure an endpoint on the S3-Compatible Storage page.
storage_bucket_requiredstorage_bucket is required when storage_mode=external.400Set storage_bucket, or configure a bucket on the S3-Compatible Storage page.
storage_credentials_requiredExternal storage credentials are required and must be configured in the panel.409Add your storage credentials on the S3-Compatible Storage page.
internal_errorAn internal error occurred. Please try again.500Retry the request. If it keeps failing, contact us.
name_not_resolvedThe domain could not be resolved.502Check the domain in url.
timeout_errorRendering did not complete within 120 seconds. Please retry the same request.
Note: The exact number of seconds in the message will match the default or configured timeout.
504Retry the request. If the page is slow to load, increase timeout.

On this page