Docs/SDKs

SDKs

Official Python and TypeScript clients generated from the same OpenAPI spec. Retries, pagination, and streaming helpers baked in.

Wordcab maintains official SDKs for Python and TypeScript. Both are generated from the same OpenAPI spec and follow the same method naming, pagination, and retry conventions. Pick whichever fits the runtime that's running your voice workload.

Python 3.9+

wordcab

pip install wordcab. Sync and async clients, retries on by default, streaming helpers for audio and chat.

 Node 18+ · Deno · Bun

@wordcab/sdk

npm install @wordcab/sdk. ESM-first, tree-shakeable, browser-safe subset via @wordcab/sdk/web.

Shared conventions

  • Auth. Clients pick up WORDCAB_API_KEY from the environment; explicit api_key always wins.
  • Base URL. Defaults to https://api.wordcab.com. Override with base_url / baseURL to hit self-hosted deployments.
  • Retries. Idempotent requests retry on 408, 429, 500, 503 with jittered exponential backoff (default 3 attempts). Pass max_retries / maxRetries.
  • Timeouts. 60 s default. Long-running (batch transcript wait, fine-tune wait) helpers override internally.
  • Pagination. list() returns an iterable page object; auto_paging_iter() / .iterate() transparently walks all pages.
  • Streaming. Chat and audio streams yield typed events; use with / for await.

Using the OpenAI SDK instead

If you already use the OpenAI SDK for chat, embeddings, or audio, point it at Wordcab's base URL — no other changes. The Wordcab SDKs are for the native /api/v1 surface (agents, calls, test suites, deployments) that OpenAI doesn't model.