Errors
Sometimes when you request a screenshot, an error might occur. This could be for a number of reasons, such as:
- An invalid access key was provided.
- You ran out of your monthly quota.
- An invalid option value was provided.
- An error occurred during the rendering process itself.
When this happens, we will return a JSON object containing a machine-readable error code and a descriptive error message. The HTTP response status code will indicate the type of the error.
Example:
{
"error_code": "invalid_options",
"error_message": "One or more options are invalid.",
"errors": [
{
"option": "url",
"message": "The \"url\" option is required."
}
]
}Errors
Below is the list of all error codes that you may experience:
| Error code | Error message | HTTP response status |
|---|---|---|
| access_key_required | The access_key parameter is required. | 400 |
| access_key_invalid | The provided access_key is invalid. | 400 |
| subscription_inactive | No active subscription for the current period. | 402 |
| monthly_quota_exhausted | Monthly quota exhausted. Upgrade your plan or wait until the next billing cycle. | 402 |
| rpm_limit_exceeded | Rate limit exceeded (requests per minute). Please retry after a short delay. | 429 |
| invalid_options | One or more options are invalid. | 400 |
| country_not_allowed | Your plan does not allow the country parameter. | 400 |
| signature_required | A valid signature is required for this API key. | 400 |
| signature_invalid | The provided signature is invalid. | 400 |
| storage_endpoint_required | storage_endpoint is required when storage_mode=external. | 400 |
| storage_bucket_required | storage_bucket is required when storage_mode=external. | 400 |
| storage_credentials_required | External storage credentials are required and must be configured in the panel. | 400 |
| internal_error | An internal error occurred. Please try again. | 500 |
| 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 |