Guides ยท Technology
API Request ID Basics
Trace requests end-to-end
This guide explains using request IDs for APIs: generate or accept an ID, propagate it across downstream calls, include it in logs and responses, and use it to debug incidents quickly.
- request id
- correlation
- logs
- tracing
- observability
Generate or accept IDs
Accept incoming request IDs from trusted gateways or generate a new one at entry.
Propagate downstream
Forward the request ID via headers for all internal calls and background jobs when relevant.
Log consistently
Include request_id in every log line and error so search is reliable.
Return to clients
Expose the request ID in responses and error payloads to help support.