Why use it
When a call fails or you need help from VMEG support, a request ID ties together server logs, idempotency records, and task creation for that HTTP request.
You can pass your own ID on any Open API request (/openapi/v1/**). If you omit it, the server generates one (32-character hex, no hyphens).
req_id marks this HTTP request for logging and support. X-Idempotency-Key prevents duplicate writes, taskId tracks an async job, and pipelineKey deduplicates webhook deliveries — use the field that matches your goal; they are often used together.What to send
Add a query parameter:
Rules:
- Use a value you can store in your own logs (for example a UUID or
order-12345-attempt-1)
- Works on
GET and POST under /openapi/v1/**
- The ID is not returned in the standard success JSON body; keep the value you sent (or log the generated ID from your client if you rely on server generation only indirectly via support lookup)
Example
If the URL already has query parameters, append with &req_id=....
Provide:
- The
req_id you used (or the approximate time and which API Key you used if you did not set one)
taskId for async jobs, if applicable- Product and endpoint path
Set req_id on the first attempt of a flow and reuse it only when retrying the same HTTP call for debugging. Start a new req_id for a logically new submission (and use a new idempotency key for new writes).
