API reference

Error code: payload_too_large

payload_too_large returns HTTP 422 with type: invalid_request_error. The fields object exceeded the size limit. When it is about one field, error.param points at fields. Branch on this code — it is stable — and apply the fix below.

2 min read

422HTTP status
payload_too_largeerror.code
FixHandling

What triggers it

The fields object exceeded the size limit. The encoded fields object was larger than 16 KiB, or had more than 60 keys.

Example response

{
  "error": {
    "type": "invalid_request_error",
    "code": "payload_too_large",
    "message": "The fields object exceeded the size limit.",
    "param": "fields"
  }
}

How to fix it

Trim the payload — move large content out of the enquiry fields.

This is deterministic: the same request will fail again until fixed. See the HTTP 422 page for the class.

In practice

In a well-built client, payload_too_large is handled by branching on error.code rather than on the human error.message, which may be reworded over time. The HTTP status (422) gives the broad invalid_request_error class; the code gives the specifics; and, on field errors, error.param pinpoints the input to fix.

This code is deterministic — retrying the identical request reproduces it — so keep it out of your retry path and instead map it to a clear, actionable message. See Map errors to user-facing messages and Read the error envelope for the pattern.

Frequently asked questions

Is payload_too_large safe to retry?

No. It is deterministic; retrying the identical request produces the identical error. Fix the cause first.

Will this code ever change?

No. Error codes are stable contract. The human message may be reworded, but the code you branch on will not change.

Do I branch on the code or the HTTP status?

Both — the status for the retry-or-not decision, the code for the specific behaviour. See the error envelope.

Funding for UK limited companies

Credicorp lends to your company, not to you personally — short-term working capital with no personal guarantee. See what your business could access.