Skip to Content
For developersVersioning

Versioning

The TrueTone API lives under a version prefix; today that is /api/v1, and the TrueTone Connector’s tools follow the same discipline.

Within v1, changes are additive. New endpoints, new optional fields, and new tools may appear at any time, and nothing you already depend on will change shape or disappear. Code written against v1 today keeps working, without edits, for as long as v1 exists.

Breaking changes only ever arrive under a new version prefix. If a request or response ever needs to change shape, that change ships as a new version alongside the old one, never on top of it.

Retirement comes with notice. If an endpoint or tool is ever retired, you will have at least 90 days of notice before it stops answering.

What this means in practice

  • Parse responses tolerantly: new fields may appear beside the ones you rely on, and your code should ignore what it does not recognize.
  • Branch on stable identifiers, such as the code values in error bodies and the requiredCapability ids, rather than on prose messages, which may be polished within v1.
  • Pin your integrations to the version prefix in the URL. There is no version header to manage.
Last updated on