payload_too_large

A Multiplayer API error, sent with HTTP 413. Status: the Multiplayer API is in private alpha; this code is part of its published contract.

When

The request body is larger than the route accepts.

What to do

Send less: state changes go over the socket, and each message's data is at most 4 KB.

The answer

Every error is a JSON body with a stable error code. Clients act on the codes they know and treat any other code as a failure of its HTTP status, and keep fields they do not know.

{
  "error": "payload_too_large",
  "detail": "A sentence that is safe to show.",
  "next": "Send less: state changes go over the socket, and each message's data is at most 4 KB.",
  "docsUrl": "https://lobbylab.gg/docs/errors/payload_too_large"
}

See also: every error code, the API reference and the docs.