API reference

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

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

Pagination

Collection endpoints return cursor-paginated results.

{
  "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).

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.