API versioning

The Mira API uses URL-based versioning to ensure backward compatibility and smooth migration between versions. The current stable version is v1.

Current version

https://api.vmira.ai/v1

All endpoints include the version in the URL path. See the endpoint reference for the full list.

How versioning works

• URL-based — The version is part of the URL: /v1/chat/completions. When v2 is released, the URL will be /v2/chat/completions.
• No implicit versions — Requests without a version in the URL are not supported. Always specify the version explicitly.
• Default version — Currently the only available version is v1. When new versions are released, v1 will continue to work.

Backward compatibility policy

Mira follows a strict backward compatibility policy within a major version:

• Non-breaking changes — Adding new fields to responses, new optional request parameters, and new endpoints — these changes do not require client code updates.
• Breaking changes — Removing fields, changing types, renaming parameters, and behavior changes — these are only possible in a new major version (v2).

Deprecation notices

If an API version is scheduled for removal, Mira provides at least 12 months for migration. Notices are published in the documentation, the blog, and sent via email.

HTTP/1.1 200 OK
Deprecation: Sun, 01 Jan 2028 00:00:00 GMT
Sunset: Sun, 01 Jan 2028 00:00:00 GMT
Link: <https://docs.vmira.ai/migration/v1-to-v2>; rel="deprecation"

Next steps