API reference

JSON everywhere, Bearer-token auth, cursor pagination, idempotency keys on writes. Explore by resource below.

Package availability

Wordcab SDKs, CLI tools, Helm charts, model weights, and deployment packages are delivered directly to each customer for self-hosted installation. They are not publicly published package-manager artifacts, so install commands in these docs are placeholders until your Wordcab team provides your private package source or offline bundle.

The Wordcab REST API follows standard conventions: JSON in and out, Bearer-token auth, cursor pagination, and idempotency keys for writes. Base URL on the cloud service:

https://api.wordcab.com/api/v1        # control plane: agents, calls, transcripts, evals, deployments

https://api.wordcab.com/v1            # OpenAI-compatible: chat, embeddings, audio

Self-hosted deployments — VPC, on-prem Kubernetes, airgap, and hybrid — expose the same paths at whatever ingress you configured. No compatibility shim, no separate API surface. See self-hosted overview for deployment shapes.

Resources

Voice

Transcripts

Batch transcription jobs.

Voice

Speech

Text-to-speech generation.

Think

Chat completions

OpenAI-compatible chat.

Think

Embeddings

Vector embeddings.

Agents

Create and manage voice agents.

Agents

Calls

Outbound / inbound call lifecycle.

Voice

Voices

Available TTS voices.

Platform

Models

List available models.

Gym

Test suites

Automated agent evaluation.

Gym

Experiments

A/B tests in production.

Deploy

Deployments

Self-hosted environments.

Auth

API keys

Manage keys.

Events

Webhooks

Configure event delivery.

Billing

Usage

Usage summaries and cost data.

Pagination

Collection endpoints return cursor-paginated results.

json

{
  "object": "list",
  "data": [ ... ],
  "has_more": true,
  "next_cursor": "cur_01HZ..."
}

Fetch the next page with ?cursor=cur_01HZ.... Default limit is 25; cap is 100.

Idempotency

All writes accept an Idempotency-Key header. Replaying the same key within 24 hours returns the same response (and never executes the underlying side effect twice).

http

POST /api/v1/calls HTTP/1.1
Authorization: Bearer wc_live_...
Idempotency-Key: campaign-2026-04-15-user-55123
Content-Type: application/json

Versioning

The URL path is versioned (/v1). Breaking changes ship as /v2; /v1 stays supported for a minimum of 12 months after a new major is released. Additive changes — new fields, new endpoints, new event types — are made in place.

← Previous

Fine-tuning

Transcripts