Errors

The PDFox API uses standard HTTP status codes. Every error response includes a machine-readable code and a human-readable message.

HTTP status codes

StatusMeaning
200Success
400Bad request — invalid or missing parameters
401Unauthenticated — missing or invalid API key
403Forbidden — key lacks permission or is revoked
404Not found — resource doesn't exist or belongs to another org
402Insufficient credits
429Rate limit exceeded
500Internal server error — something went wrong on our end

Error codes

CodeDescription
validation_errorRequest body failed schema validation
template_not_foundThe template ID doesn't exist in your org
insufficient_creditsYour org has run out of credits
job_not_foundJob ID doesn't exist or belongs to another org
render_failedThe PDF render itself failed — check your template HTML
rate_limit_exceededToo many requests — back off and retry
500 errors are transient. Retry with exponential back-off starting at 1 second. If errors persist for more than a few minutes, check status.pdfox.com.

Rate limits

Limits are enforced per API key. When you hit 429, the response includes a Retry-After header with the number of seconds to wait before retrying.

{
  "error": {
    "code": "validation_error",
    "message": "templateId is required",
    "details": [
      { "field": "templateId", "issue": "Required" }
    ]
  }
}