Official SDKs

Thin clients over the xconvert public API. The SDKs forward partial requests as-is; the server applies feature baselines + defaults from the schema (developer-api §5.2.5.5), so most calls are 5–10 lines of code.

TypeScript / JavaScript

Node 18+. Works in any CJS or ESM project; types ship with the package.

Shell

npm install @xconvert/sdk

Package: @xconvert/sdk · Repo: harithay/xconvert-sdk-typescript

TypeScript quickstart →

Python

Python 3.9+. Built on httpx; sync + async clients available.

Shell

pip install xconvert

Package: xconvert · Repo: harithay/xconvert-sdk-python

Python quickstart →

Don't see your language?

The full OpenAPI 3.1 spec is at /docs/_assets/openapi-index.json. Any OpenAPI codegen produces a working client — we use openapi-typescript-codegen (TS) and openapi-python-client (Python) internally. Go, Ruby, C#, and Java clients are on the roadmap; vote / request via GitHub.

Auth

Every request carries Authorization: Bearer xck_live_... (production) or xck_test_... (staging). Mint a key from the portal. The SDK accepts the raw token; we recommend pulling it from the environment so it never lands in source control:

Shell

export XCONVERT_API_KEY="xck_test_..."

Versioning

Both SDKs are subpath-versioned to match the API major. Use @xconvert/sdk/v1 / xconvert.v1 for the current API. When v2 ships you can migrate import-by-import; both subpaths coexist in the same package until v1 sunsets per the deprecation policy.