Versioning

How the Ostra API and the Ostra models are versioned, how to tell which model answered, and what counts as a breaking change.

API version

The API version is in the path: /api/v1. Within v1, changes are additive: new endpoints, new optional request fields, new response fields, new error messages and new enum values (for example a new triage class). Write clients that ignore fields they don't know and handle unknown enum values gracefully.

Breaking changes (removing or renaming a field, changing a type, changing what a field means) ship as a new path version, with notice.

Model versions

Responses tell you which model answered, so you can log it and compare results over time:

ModelWhere
Ostra Decisionmodel in /predict and /batch responses (ostra-lite@v.beta.5), and per decision output.model.release, version and content_hash. GET /models lists the live release.
Ostra Proostra-model-version response header (1.0) and version in GET /models.

Ostra Decision is in beta and gets new releases as its models improve. A release can change answers for the same input; it never changes the request or response shape within v1. Every task's model must pass a quality gate before release: gate_passed is true in normal operation, and when it isn't, that task answers defer with defer_reason: "model_gate_failed" instead of a low-quality answer. A new release also clears the 24-hour answer cache.

Ostra Pro is at version 1.0. A new version will be announced in the changelog before it replaces the current one.

Model ids

Display namemodel value
Ostra Decisionostra-lite
Ostra Proostra-pro

The id ostra-lite is kept for compatibility; it's the same model the Console calls Ostra Decision.

Was this page helpful?

On this page