Versioning

How the API changes over time.

The version is in the path: /v1. Within v1, Ingenee only makes additive changes:

  • new endpoints
  • new optional request fields and query parameters
  • new response fields
  • new error code values and new webhook events

Your client should ignore fields it doesn't recognise. A change that would break a v1 client ships as /v2, and /v1 stays available alongside it.

The machine-readable description of the API is always at:

https://dev.app.ingenee.ai/api/v1/openapi.json

It's OpenAPI 3.1, so you can generate a typed client from it with openapi-typescript, openapi-generator or similar tools.