Versioning

How the API is versioned and what counts as a breaking change.

dev · https://api.dev.oprag.ai

The version is in the path. Every endpoint except health and bootstrap lives under /v1, and /v1 is the only version there has been. There is no version header and no date-based pinning.

What can change without a new version

  • New endpoints.
  • New optional request fields.
  • New response fields — so parse leniently and ignore what you do not recognise.
  • New values in an open-ended enumeration, such as a new error message string.

What would require one

  • Removing or renaming a response field.
  • Making an optional request field required.
  • Changing a field's type, or the meaning of a status code.

Product changes are recorded in the changelog; SDK changes in the SDK changelog.

Ready to ship?

Get started free