Request ID

Every response carries a request ID — a UUID that uniquely identifies the request end-to-end. It is the single most useful piece of information you can attach to a support ticket.

At a glance


Header	`X-Request-Id`
Direction	Response only
Format	UUID v4
Generated by	The API, on every request

Reading the ID

The API returns X-Request-Id on every response — success or error.

The header name is case-insensitive in HTTP, so X-Request-Id, x-request-id, and X-REQUEST-ID are equivalent.

What you should do with it

Log it on every response. Put X-Request-Id in your structured logs alongside the URL and status code.

Quote it in support tickets. "Got a 502 around 13:42 UTC, request ID 0f4b2e2e-9c2a-4d2c-8b91-3a86d5f6f1c7" turns a multi-hour investigation into a one-minute lookup.

Inside the response body

A few endpoints surface the request ID inside the JSON body too — for example, the INTERNAL_ERROR envelope includes a request_id field for convenience. The header is the canonical place to read it; the body is a debugging aid.

At a glance#

Reading the ID#

What you should do with it#

Inside the response body#

At a glance

Reading the ID

What you should do with it

Inside the response body