Guide
Request IDs & support
The X-Request-Id header on every response, and how to quote it to support.
Every response from the API carries an X-Request-Id header: successful responses and errors alike, whatever the status code. Its value identifies that one request in our logs. When you contact support about a request, quote this id and we can find exactly what happened, without you having to reconstruct job ids and timestamps.
What it looks like
HTTP/2 401
content-type: application/json
…
x-request-id: c6508345449fc5f036a95e0fee3c773b
HTTP header names are case-insensitive, so your client may show it as x-request-id. Treat the value as an opaque string: store it as you received it, and don't parse it or depend on its length.
Try it
This request needs no API key. It sends an id of its own and prints the request id of the response:
curl -s -D - -o /dev/null "https://api.api2convert.com/v2/statuses" \
-H "X-Request-Id: my-order-4711" | grep -i '^x-request-id:'It prints one line, the id the API gave this request. That is the id you sent when the API adopts it, else one it generated, for example:
x-request-id: 848ebb9a44573b299aa6368cd6ff8cc1Any other call shows the same header, including one that fails. Add -H "x-api2convert-api-key: <your-api-key>" to try it on your own jobs.
Sending your own id
You may send an X-Request-Id header with your request, for example the id your own system gives that call. It must be 1 to 128 characters long and use only letters (A–Z, a–z), digits, dot, underscore and dash. A value in any other format is ignored: the request is processed normally and never fails because of it.
The API does not guarantee that it adopts the id you send. When it doesn't, or when you send none, it generates an id itself. Either way, the id that identifies your request is the one in the response's X-Request-Id header, so that is the one to store.
Contacting support
Log the X-Request-Id of every request that fails, next to its status code and response body. When you contact support about a request, quote that id, one per request, together with the approximate time it was sent. It is the fastest way for us to find it.
A request id is not a secret: it identifies one request and grants no access, so it is safe to put in a support ticket. Never share your API key the same way (see Security & data protection).
A request id and a job id are different things. The job's id stays the same across every call you make about that job, while each of those calls has a request id of its own. When you ask about a job, give the job id and the request id of the call that surprised you.