Errors

Error envelope and status codes.

Errors return a non-2xx status and a consistent JSON envelope:

json

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS",
    "message": "Not enough credits to complete this request."
  }
}

Status Codes

Parameter	Type	Description
`400 / 422`	VALIDATION_ERROR	The request body failed validation. The error includes the offending fields.
`401`	INVALID_API_KEY	Missing, malformed, or revoked API key.
`402`	INSUFFICIENT_CREDITS	Your Peep Card can't cover the request. Top up or wait for a refund.
`403`	FORBIDDEN	The key lacks access to a paid-tier feature (e.g. robots.txt bypass).
`404`	NOT_FOUND	No job or resource with that id.
`429`	RATE_LIMITED	Too many requests. Honor the Retry-After header.
`500`	INTERNAL_ERROR	Something went wrong on our side. Safe to retry.