Skip to Content
API ReferenceVersioning and deprecation

Versioning and deprecation

Versions

Both APIs carry their major version in the path:

GET https://api.voix.tech/public/v1/calls POST https://ingest.voix.tech/v1/submit

The current version is v1. Unversioned paths are aliases of v1: POST https://ingest.voix.tech/submit keeps working and behaves exactly like /v1/submit.

Non-breaking changes

These can ship in the current version at any time:

  • New endpoints.
  • New optional request parameters or body fields.
  • New fields in responses.
  • New values in enums, such as a new call status.

Ignore response fields you do not recognise, and handle unknown enum values without failing.

Breaking changes

Removing or renaming a field or endpoint, adding a required parameter, or changing the meaning of an existing value is breaking. Breaking changes ship only in a new version, such as /public/v2 or https://ingest.voix.tech/v2. The previous version keeps working until its sunset date.

Notice

An endpoint or version is deprecated at least 6 months before it is removed or changed incompatibly. It keeps working until its sunset date.

Deprecation headers

A deprecated endpoint answers with these headers on every response:

HeaderMeaning
DeprecationWhen the endpoint is or was deprecated, in Unix seconds (RFC 9745 ).
SunsetWhen the endpoint stops responding, as an HTTP date (RFC 8594 ).
LinkThis page, with rel="deprecation".
Deprecation: @1798761600 Sunset: Thu, 01 Jul 2027 00:00:00 GMT Link: <https://docs.voix.tech/api/versioning>; rel="deprecation"

Current status

DeprecatedReplacementSunset
Pasted user access tokens on the MCP serverSign in with OAuthAnnounced at least 6 months ahead
Last updated on