Voice API/Lifecycle
Swagger UIOpenAPI

Lifecycle

Ship integrations that can evolve safely.

The stable API is exposed under /api/v1. Use scoped OpenAPI specs, contract tests, and changelog review before promoting new agent or admin automation code.

Request API keyStart buildingEndpoint guidesAuthenticationProduction readiness
Runtime APIBearer tenant keys
Admin APIx-admin-key
TelephonyTwilio signatures
SpecsOpenAPI 3.1

Stable path

The stable API surface is exposed under /api/v1. Legacy unversioned endpoints can exist for compatibility, but new integrations should use versioned paths and scoped OpenAPI specs.

Contract workflow

  1. Generate client types from /api-docs/public.json or /api-docs/admin.json.
  2. Pin generated clients to a known spec snapshot in your CI pipeline.
  3. Run contract tests against staging before promoting agent, admin, or webhook changes.
  4. Review the changelog during release planning.

Compatibility policy

Change typeCompatibility
Add optional response fieldCompatible. Clients should ignore fields they do not use.
Add endpoint or schemaCompatible. Regenerate clients when you need the new surface.
Rename required fieldBreaking. Requires migration guidance and version planning.
Remove enum valueBreaking. Requires deprecation notice and customer coordination.