Skip to main content
The version is in the path: https://api.voyager.so/v1.

​
What can change in v1

Within v1, changes are additive only. Voyager may:
  • add endpoints, optional request fields and query parameters,
  • add fields to responses and objects,
  • add new error codes, event types, job types, model operations and enum values (such as a model status),
  • add, update and retire models in GET /v1/models.
Write clients that ignore fields they don’t know and handle unknown enum values and error codes gracefully. Model availability isn’t part of the API version: read the model list instead of hard-coding it. Voyager won’t, within v1: remove or rename a field, change a field’s type or meaning, make an optional field required, or rename an error code.

​
Breaking changes

If a breaking change is ever needed, it will come behind a dated Voyager-Version request header (for example Voyager-Version: 2027-01-15). You’ll opt in to a new version by sending the header; requests without it keep the behavior described in these docs. The header doesn’t exist yet; you don’t need to send anything today.

​
Stay current