API access

The SDKs are the supported way to integrate with Convilyn. They wrap the HTTP API with idiomatic clients, typed models, retries, idempotency, and auth handling. Python is the supported SDK today; TypeScript is in pre-release and Go is coming soon.

Integrate through an SDK

The consumer SDK is generated against the same API behaviour, so you get the full surface — files, conversion, goal workflows, marketplace, account — without hand-rolling HTTP:

Calling an endpoint the SDK doesn't wrap yet

The convilyn CLI ships a gh-style api sub-command that issues an authenticated request with the same retry / idempotency behaviour as the high-level methods — useful for anything the typed surface hasn't reached:

convilyn api GET /api/v1/health
convilyn api POST /api/v1/echo --input body.json

Integration conventions

These hold across the API regardless of which SDK you use:

• Authentication — Bearer token; consumer calls use a ck_ key (see Authentication).
• Idempotency — mutating verbs accept an Idempotency-Key header; the SDKs auto-stamp it so a retried create never double-charges.
• Errors — a consistent error envelope surfaced by each SDK as typed exceptions (see the per-language error reference).
• Rate limits — HTTP 429 responses carry a reset hint; the SDKs back off and retry automatically.

Where to go next