API Errors
If success is false in the response, then you will also receive an error_code to provide additional information.
Here is a quick list of the errors you may encounter using the API.
API Error Codes
| error_code | Description |
|---|---|
| missing_access_token | Code returned when no API key is provided. |
| invalid_access_token | Code returned when the API key is not associated with a valid account. |
| missing_or_invalid_url | Code returned when the URL provided is required and missing or is invalid. |
| invalid_hash_key | Code returned when the HMAC SHA1 hash is invalid when using the API Secret Token and API Publishable Key for public web page usage. |
| usage_limit_exceeded | Code returned when your Monthly Screenshot Allotment is depleted for the current month. |
| rate_limit_exceeded | We typically limit API requests to 1000 per minute, with some leeway for bursts. |
| screenshot_configuration_not_found | Code returned when the provided screenshot_configuration_id does not match a valid screenshot in your account. |
| screenshot_already_in_progress | Code returned by the capture endpoint if a screenshot is already currently in progress for the requested Screenshot Configuration. |
| screenshot_capturing_in_progress | Code returned by the status endpoint if the selected job_id is currently in progress. |
| screenshot_not_found | Code returned by the status endpoint if the selected job_id is not found under your account. |
| invalid_schedule_provided | Code returned if the schedule provided in the create or update endpoints is invalid in some way. The JSON will also include a note key, which will provide more information on what happened. |
| invalid_multi_step_actions | Code returned if the multi_step_actions array is not valid. Click here to learn more about the Multi-Step Functionality |
| billing_not_up_to_date | Code returned if the account is missing a payment and is not on the free plan. |
| invalid_page_number | Code returned when an invalid page number is received. Page numbers should an integer greater than 0. |
| invalid_limit | Code returned when an invalid limit is received. The record limit should be an integer greater than 0 and less than 1001. |
| invalid_after_date | Code returned when an invalid after date is received. The after date should be a unix timestamp with or without milliseconds. |
| invalid_before_date | Code returned when an invalid before date is received. The before date should be a unix timestamp with or without milliseconds. |
| byok_plan_required | Bring Your Own AI needs a paid screenshot plan. Pick a plan, then add the addon. |
| byok_addon_required | The Bring Your Own AI addon is not active on the account. |
| ai_provider_not_configured | No verified key is stored for the requested AI provider. |
| ai_provider_unsupported | ai_provider must be pagepixels, anthropic, openai or openrouter. |
| ai_model_required | ai_model is required for OpenAI and OpenRouter when no default model is stored. |
| ai_model_not_supported | The model is not in the provider's compatible list of vision models. |
| ai_provider_key_rejected | The AI provider rejected the stored key. |
| ai_provider_unavailable | The AI provider could not be reached. Try again shortly. |
| invalid_ai_structured_fields | The ai_structured_fields list is invalid. The note names the field. |
| byo_proxy_plan_required | Bring Your Own Proxy needs a paid screenshot plan. Pick a plan, then add the addon. |
| byo_proxy_addon_required | The Bring Your Own Proxy addon is not active on the account. |
| custom_proxy_not_found | No stored proxy matches custom_proxy_id. |
| invalid_proxy | The proxy settings are invalid. The note names the problem. |
| proxy_auth_failed | The proxy rejected the credentials. |
| proxy_connection_failed | Could not connect through the proxy. |
| unexpected_error | We encountered an issue on our end and have been notified. Please contact support if you continue to experience the issue. |
And here is a short summary of HTTP status codes for easy reference.
HTTP Status Codes
| Status | Meaning |
|---|---|
| 200 - OK | Success |
| 400 - Bad Request | Request contains bad syntax or can't be fulfilled. |
| 401 - Unauthorized | Request does not contain a valid API key. |
| 403 - Forbidden | The API key was valid but doesn't have the necessary permissions to perform the request. |
| 404 - Not Found | The requested resource doesn't exist. |
| 405 - Method Not Allowed | The requested resource does not support the method / verb used in the request. |
| 408 - Request Timeout | The request took longer than the allotted wait time. |
| 429 - Too Many Requests | Too many requests hit the API too quickly. |
| 500, 502, 503, 504 - Server Errors | The server failed to fulfil the request. Wait a few minutes and try the request again. If the errors persist, please contact us. |
Support
Questions? Contact us anytime by email:
support-tickets@pagepixels.com
Or send us a message through our Support page.