OpenAPI spec

The complete API is described by a machine-readable OpenAPI 3.1 document — the same source the docs and the official SDK are reconciled against, so it never drifts from the live API.

Browse the API

Explore every endpoint, schema, and example interactively below — rendered live from openapi.json, so it always reflects the current API.

The spec

Download or link it directly: pristinesend.com/openapi.json. It covers all nine endpoints, the error envelope and the full error-code list, authentication, pagination, idempotency, and the test/live environment.

Download openapi.json →

Import into tools

Point Postman, Insomnia, Bruno, or a Swagger/Scalar viewer at the URL:

# Import directly into Postman, Insomnia, or any OpenAPI tool:
https://pristinesend.com/openapi.json

Generate a client

Generate a client in any language from the spec. For Node / TypeScript, the hand-tuned official SDK gives you a better experience (typed errors, the cursor iterator, idempotency, retries, and react:).

# Generate a typed client in your language with openapi"color:#ff7b72">-generator:
npx @openapitools/openapi"color:#ff7b72">-generator"color:#ff7b72">-cli generate \
  "color:#ff7b72">-i https://pristinesend.com/openapi.json \
  "color:#ff7b72">-g typescript"color:#ff7b72">-fetch "color:#ff7b72">-o ./pristinesend"color:#ff7b72">-client

# For Node/TypeScript, prefer the official SDK instead:
npm install pristinesend