snake_case field names. The endpoint pages in this section are generated from the OpenAPI document.
Base URL
/v1.
Authentication
Send your credential on every request, in either header:Bearer token. See Authentication and API keys.
A request without a valid credential gets 401 with code auth.invalid_key. An expired sign-in gets 401 with code auth.token_expired.
Content type
SendContent-Type: application/json with a JSON body on every POST. Successful replies are application/json. Errors are application/problem+json.
Endpoints
Every
POST endpoint returns 200 on success.
Request IDs
Every response carries anX-Request-Id header, including errors. The same value is in the body as request_id on every POST reply and every error.
Errors
Errors follow RFC 9457 problem details, with content typeapplication/problem+json.
Some errors add fields:
Branch on
code, not on detail. See Errors for every code.
Idempotency
Send anIdempotency-Key header (8 to 200 printable characters, no spaces) on any POST. The same key with the same body within 24 hours returns the first answer and is charged once.
A replayed answer carries Idempotent-Replayed: true. See Idempotency.

