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 code | Error message | HTTP status | What to do |
|---|---|---|---|
access_key_required | An access key is required. | 401 | Send your access key. See Authentication. |
access_key_invalid | The provided access key is invalid. | 401 | Check that the access key is on the API Keys page and that you copied all of it. |
subscription_inactive | No active subscription for the current period. | 403 | Check your plan on the Billing page. |
monthly_quota_exhausted | Monthly quota exhausted. Upgrade your plan or wait until the next billing cycle. | 429 | Upgrade your plan on the Billing page, or wait for the number of seconds in the Retry-After header. |
rpm_limit_exceeded | Rate limit exceeded (requests per minute). Please retry after a short delay. | 429 | Retry after the number of seconds in the Retry-After header. |
invalid_options | One or more options are invalid. | 400 | The errors array names each invalid option and explains what's wrong with it. |
country_not_allowed | Your plan does not allow the country parameter. | 403 | Upgrade to a paid plan, or use your own proxy instead. |
signature_required | GET: 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. | 403 | See Signed Requests. |
signature_invalid | The provided signature is invalid. | 403 | See Signed Requests. |
storage_endpoint_required | storage_endpoint is required when storage_mode=external. | 400 | Set storage_endpoint, or configure an endpoint on the S3-Compatible Storage page. |
storage_bucket_required | storage_bucket is required when storage_mode=external. | 400 | Set storage_bucket, or configure a bucket on the S3-Compatible Storage page. |
storage_credentials_required | External storage credentials are required and must be configured in the panel. | 409 | Add your storage credentials on the S3-Compatible Storage page. |
internal_error | An internal error occurred. Please try again. | 500 | Retry the request. If it keeps failing, contact us. |
name_not_resolved | The domain could not be resolved. | 502 | Check the domain in url. |
timeout_error | Rendering 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. | 504 | Retry the request. If the page is slow to load, increase timeout. |