Versioning
The major version is in the address: https://kelki.ai/api/v1. Within a version, changes are additions only.
What may change in v1
- New fields in responses, new routes, new error codes.
- New values of an enumeration documented as extensible.
Your code must ignore unknown fields and handle an unknown error code according to its HTTP status.
Breaking change
- It opens a new version (
/v2); today,/v2…returns404 not_found. /v1stays served at least 12 months after the announcement.- The announcement goes through the changelog and the
Deprecation(RFC 9745) andSunset(RFC 8594) headers on the responses concerned.
Knowing which version answers
Every response carries Kelki-Api-Version: 1 and the revision date. Webhook events carry api_version.