API Reference

API Error Reference

Troubleshoot Scrnpix API errors with detailed explanations, reproduction steps, and fix instructions for every error code.

Find Your Error

Every error returned by the Scrnpix API is documented below with its HTTP status code, trigger conditions, and step-by-step fix instructions. Search by status code, error message, or keyword to find the solution you need.

400/screenshot, /animate

Missing `url` query parameter

How to fix the Scrnpix API error when the required url query parameter is missing from your screenshot or animate request.

400/screenshot, /animate

URL must be http(s) and not private/localhost

How to fix the Scrnpix API error when the target URL resolves to a private, localhost, or non-HTTP address.

400/animate

clip=true requires clip_width and clip_height

How to fix the Scrnpix API error when clip=true is set but clip_width or clip_height is missing from your animate request.

400/animate

clip rectangle must fit within viewport

How to fix the Scrnpix API error when the clip rectangle extends beyond the viewport dimensions in an animate request.

400/checkout/session, /subscription/change/preview, /subscription/change, /playground/*

Invalid JSON body

How to fix the Scrnpix API error when the request body contains malformed or invalid JSON.

401/screenshot, /animate

Unauthorized

How to fix the Scrnpix API 401 Unauthorized error when the X-KEY header is missing from your screenshot or animate request.

401/screenshot, /animate

Unauthorized

How to fix the Scrnpix API 401 Unauthorized error when the provided API key is invalid, expired, or disabled.

401/api-keys, /subscription, /usage, /checkout/session, /subscription/change/preview, /subscription/change, /billing/portal, /playground/*

Missing authorization

How to fix the Scrnpix API 401 error when the session cookie is missing from requests to dashboard endpoints.

401/api-keys, /subscription, /usage, /checkout/session, /subscription/change/preview, /subscription/change, /billing/portal, /playground/*

Invalid token

How to fix the Scrnpix API 401 error when the session JWT token is expired, malformed, or has an invalid signature.

402/screenshot, /animate

insufficient_credits

How to fix the Scrnpix API 402 error when your account has run out of credits for screenshot or animation requests.

403/screenshot, /animate

Forbidden

How to fix the Scrnpix API 403 Forbidden error when your request Origin header is not in the allowed origins list.

404*

Not found

How to fix the Scrnpix API 404 Not Found error when requesting an endpoint that does not exist.

404/api-keys/:id/disable, /api-keys/:id/enable

API key not found

How to fix the Scrnpix API 404 error when trying to enable or disable an API key that does not exist.

429/screenshot, /animate

rate_limit_exceeded

How to fix the Scrnpix API 429 error when you exceed your plan's rate limit for screenshot or animation requests.

500/screenshot

Rendering error

How to fix the Scrnpix API 500 Rendering Error when the browser fails to capture a screenshot of the target page.

500/animate

Animation error

How to fix the Scrnpix API 500 Animation Error when the browser fails to create a scrolling GIF animation of the target page.

Related Categories

Need More Help?

Check your API key and subscription status in the dashboard, or explore our language guides for integration examples.

Go to Dashboard