Skip to main content

Error Codes

The DomShot API uses standard HTTP status codes and returns structured error objects.

Error response format

All errors return a JSON object with the following structure:

Error codes

401 Unauthorized

invalid_token

Invalid or expired API key.
Solution: Check your API key in the Dashboard.

inactive_subscription

No active subscription found.
Solution: Ensure you have an active subscription.

402 Payment Required

insufficient_balance

Free tier balance exhausted.
Solution: Upgrade to a paid plan to continue using the service.

429 Rate Limit Exceeded

rate_limit_exceeded

Too many requests within the rate limit window.
Solution: Wait for the number of seconds specified in retryAfter or upgrade your plan for higher limits.

500 Internal Server Error

screenshot_failed

Screenshot generation failed.
Causes:
  • Target URL is unreachable
  • Page timeout
  • Invalid URL
  • Internal server error
Solution: Verify the target URL is accessible, try increasing the timeout parameter, or contact support if the issue persists.

Status code reference

Rate limit headers

All responses include rate limit information:

Troubleshooting