Error codes

Learn about the HTTP status codes and error responses returned by the API.

The API uses conventional HTTP status codes: 2xx means the request succeeded, 4xx means the problem is with the request, and 5xx means something failed on Pixel's side (rare). Whether and how to retry depends on the code; the table below covers each one.

Error response format

Error responses use the ApiError schema, a JSON object with these fields:

• code: the machine-readable error code. The table below lists every value.
• message: a human-readable explanation of what went wrong.
• details: optional; present when the error can point at what in the request was wrong. Its issues list one entry per problem, each with a dotted path (empty for the request as a whole) and, where the validator gives them, a message and its code. See ApiErrorDetails.
• retryAfter: optional; the number of seconds to wait before retrying. Set for rate_limited and service_unavailable.

{  "code": "invalid_request",  "message": "applicationId must be a valid UUID.",  "details": {    "issues": [      {        "path": "applicationId",        "message": "Invalid uuid",        "code": "invalid_format"      }    ]  }}

Error codes