Skip to content

Concepts

Versioning

  • The version is in the URL: /v1. Within v1 we only add things: endpoints, optional parameters, response fields, enum values and error codes.
  • Changes that would break a correct client go into a new version, /v2. That covers removing or renaming a field, changing its type or meaning, a new required parameter, stricter validation or a changed default.
  • Ignore fields you don't recognise, and treat an unknown enum value or error code like the most cautious one you know. Both can appear without notice within v1.
  • An error code is a stable identifier: within v1, codes are only added, never renamed or removed.
  • v1 keeps working for at least 12 months after v2 is released.
  • Before anything is retired, we email every admin who holds a key. Affected responses also carry Deprecation and Sunset headers with the dates, and a Link header with rel="deprecation" pointing at the changelog.

This pilot covers the endpoints in the API reference. Tell us what else you need at support@getprice.ai.