Request IDs

Every API response carries a request ID in the x-syntic-request-id header, such as req_6f1c2a9e0b7d4c3a8e5f1b2d. It points to exactly one request, so it’s the fastest way for support to see what happened.

Where to find it

• In the response header x-syntic-request-id, on successful and failed responses. On streamed answers it arrives before the first piece of text.
• In error bodies, as request_id inside the error object. Error responses also repeat it in an x-request-id header.
• In the Console: the Request Log Export on the Export Records page has a request_id column for your recent requests.

Each retry gets a new ID. Store the value as it is; don’t parse it, because its length may change.

See it with curl

Add -D - to print response headers:

curl -s -D - https://app.syntic.ai/v1/chat/completions \
  -H "Authorization: Bearer $SYNTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"stream": false, "messages": [{"role": "user", "content": "Hi"}]}' \
  | grep -i '^x-syntic-request-id'

Log it

Write the request ID to your logs next to your own record of the call, especially for errors. When something goes wrong days later, you can match a user’s complaint to the exact request.

When you contact support

Include:

1. The request ID
2. The approximate time and your time zone
3. The status code and error code
4. Your Organization ID from the Console’s General page

Never include your API key. Support doesn’t need it.

Related

• Common API error codes
• Contact support