Errors use a stable error.code. Bad input is always a 4xx, never a 5xx.
| Code | Status | Meaning | How to fix |
|---|---|---|---|
bad_request | 400 | The request could not be understood. | Check the request line, headers and parameters against the endpoint documentation. |
invalid_json | 400 | The request body is not valid JSON. | Send a well-formed JSON document with the header Content-Type: application/json. |
unauthorized | 401 | This request is not authorised. | Call the API through RapidAPI with your X-RapidAPI-Key and X-RapidAPI-Host headers. |
not_found | 404 | No endpoint exists at this path. | See /docs or /openapi.json for the list of endpoints. |
method_not_allowed | 405 | This endpoint does not support the HTTP method used. | Use one of the methods listed in the Allow response header. |
payload_too_large | 413 | The request body exceeds the size limit for this endpoint. | Reduce the payload below the documented limit, or split the work across several calls. |
unsupported_media_type | 415 | The request body has an unsupported Content-Type. | Set the Content-Type header to one of the types documented for this endpoint. |
invalid_parameters | 422 | One or more parameters are invalid. | Correct the fields listed in error.details; each entry names the field and the rule it broke. |
unknown_field_type | 422 | The field type is not in the catalogue. | GET /v1/fields lists every field type (e.g. person.full_name, internet.safe_email, number.int). |
invalid_schema | 422 | The JSON Schema cannot be used to generate data. | Use draft 2020-12 keywords: type, properties, items, enum, const, minimum/maximum, minLength/maxLength, format, minItems/maxItems, x-faker. |
schema_too_complex | 422 | The schema is too deep or expands to too many values. | At most 8 levels of nesting, 500 values per instance and 20 items per array. |
too_many_values | 422 | The request would generate too many values. | Keep count × fields ≤ 10,000 per request; page with different seeds for more data. |
rate_limited | 429 | Too many requests. | Wait for the number of seconds in the Retry-After header, or upgrade your plan. |
internal_error | 500 | An unexpected error occurred. It has been logged without your payload. | Retry the request. If it keeps failing, contact support with the request_id. |
upstream_unavailable | 503 | A network dependency is temporarily unavailable and no cached value exists. | Retry after the number of seconds in the Retry-After header. |