For the complete documentation index, see https://transmute.documentationai.com/llms.txt. Every page is also available as Markdown: add .md to its URL, or request it with an Accept: text/markdown header.
Every header the transmute API sets or reads: request correlation, API version, rate limit, quota, warnings, paging, idempotency, and the header forms of request options.
Correlation
Header
On
Meaning
X-Request-Id
Every response
Correlation id (req_<ulid>), echoed from your inbound X-Request-Id if you send one. Also present as requestId in error bodies. Quote this to support — it's how we find a request in our body-free logs.
API version
Header
On
Meaning
X-Api-Version
Every response on the /v1 API-key routes, including auth, rate-limit and quota rejections
The API version the request was served under: your X-Api-Version request header if you sent one, else your API key's pin, else the current version (2026-06-01). See Migrating from SR2025 to SR2026.
The job's status (queued, processing, completed, failed, partial, expired), because the NDJSON item stream has no envelope to carry it. See Batch & Jobs.
X-Next-Cursor
GET /v1/history CSV exports
Cursor for the next page; absent on the last page. JSON responses carry next_cursor in the body instead. See Request History.
Idempotency
Header
Meaning
Idempotency-Replayed: true
This response came from the 24-hour replay cache — it was not re-executed and not billed. Possible on POST /v1/convert, /v1/convert/batch, /v1/normalize, /v1/validate and /v1/enrich. See Idempotency.
Request headers you can send
Header
Meaning
Authorization: Bearer ...
Your API key or OAuth token
Idempotency-Key
Opt-in safe retries (1–255 chars)
X-Request-Id
Your own correlation id, echoed back
X-Api-Version
Pin date-versioned behaviour for this request (today: the default Standards Release). Supported value: 2026-06-01. An unknown value is invalid-input. Wins over the key's pin. Not read on POST /v1/oauth/token.
When you send a raw message body instead of a JSON envelope, these headers carry the options. They have the lowest precedence: a JSON envelope option and the matching query parameter both win over the header.
Header
Query equivalent
Routes
Meaning
X-Transmute-From
from
POST /v1/convert, /v1/normalize, /v1/validate, /v1/verify, /v1/anonymize
Source format id (for example mt940); omit to auto-detect
X-Transmute-To
to
POST /v1/convert, /v1/verify
Target format id
X-Transmute-To-Version
toVersion
POST /v1/convert
Target message version
X-Transmute-SR-Version
srVersion
POST /v1/convert, /v1/normalize, /v1/validate, GET /v1/samples
Standards Release (SR2025, SR2026); an explicit value always wins over the API version's default
X-Transmute-Envelope
envelope
POST /v1/convert (none, apphdr, fin), POST /v1/normalize (none, include)
Message-envelope handling: which header block to emit on convert, or whether to include the source envelope in normalized JSON
X-Transmute-Trace
trace
POST /v1/convert
true attaches the mapping trace; needs a JSON response
X-Transmute-Verify
verify
POST /v1/convert
true attaches the round-trip loss report; needs a JSON response
X-Transmute-Anonymize-Salt
none
POST /v1/anonymize
Your salt (16 to 256 characters). Header only; never accepted as a query parameter, so it never appears in a URL
