API Versioning

API Versioning

The SolidRusT AI API uses semantic versioning to ensure stability while enabling continued development.

Current Version

API v1

Status: Current

Released: January 16, 2026

Base URL: https://api.solidrust.ai/v1

Version Format

Our API versions follow the format v{major} in the URL path:

https://api.solidrust.ai/v1/chat/completions
                          ^^
                          Version prefix

Version Lifecycle

Stage	Description	Support
Current	Active development, latest features	Full support
Stable	Feature-complete, maintenance only	Full support
Deprecated	Scheduled for removal	6 months minimum
Sunset	Read-only, no new features	Limited support

Breaking Changes Policy

We consider the following to be breaking changes that warrant a new major version:

• Removing endpoints or parameters
• Changing response structure
• Modifying authentication requirements
• Altering error code meanings

Non-breaking changes (applied to current version):

• Adding new endpoints
• Adding optional parameters
• Adding new fields to responses
• Performance improvements

Migration Strategy

When a new API version is released:

1. Announcement: Published in Changelog at least 30 days before release
2. Overlap Period: Both versions run in parallel for minimum 6 months
3. Migration Guide: Detailed guide with code examples provided
4. Deprecation Warnings: Old version returns X-API-Deprecated header
5. Sunset: Old version returns 410 Gone after sunset date

Tip

Subscribe to our changelog to receive notifications about upcoming API changes.

Version History

v1 (Current) - January 2026

Initial public release including:

• Chat Completions API (OpenAI-compatible)
• Embeddings API with bge-m3 model
• RAG endpoints (semantic, keyword, hybrid search)
• Agent API with tool support

See the full changelog for details.

Specifying API Version

Via URL Path (Recommended)

curl https://api.solidrust.ai/v1/chat/completions \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"model": "vllm-primary", "messages": [...]}'

Via Header (Future Support)

In future versions, you may also specify the API version via header:

curl https://api.solidrust.ai/chat/completions \
  -H "X-API-Version: 2026-01-16" \
  -H "X-API-Key: your-api-key"

Note

Header-based versioning is planned for v2. Currently, use the URL path method.

SDK Version Compatibility

Our SDKs are versioned independently but maintain compatibility:

SDK	Version	API Compatibility
Python	1.x	v1
JavaScript	1.x	v1

SDKs automatically use the correct API version. Update your SDK to access new features.

Questions?

If you have questions about API versioning or need migration assistance:

• Check the Changelog for recent changes
• Review our Getting Started guide
• Open an issue on GitHub