API Versioning
Current version
The Public API is versioned by path prefix: all endpoints live under/api/public/v1. The v1 indicates the current major version.
- Base URL:
https://api.truedy.ai/api/public/v1 - OpenAPI:
https://api.truedy.ai/api/public/v1/openapi.json
What we guarantee
- Stability: We avoid breaking changes to existing request/response shapes and behavior within the same major version.
- Additive changes: New optional fields, new endpoints, and new optional query parameters may be added without a version bump. Your client should ignore unknown fields and tolerate extra fields in responses.
- Deprecation: If we deprecate a field or endpoint, we will document it and provide a transition period before removal. Deprecation notices may appear in response headers or the changelog.
When we may introduce a new version
- Breaking changes: Removing or renaming fields, changing error shapes, or changing semantics would be done in a new path (e.g.
/api/public/v2) with advance notice. - Sunset policy: We will document the minimum supported version and give notice before disabling an old version.