Skip to content
Beta: the Biskèt Partner API may still change before v1 is final. Sandbox access is by request:partners@bisket.ai.

Versioning

  • The major version is in the path (/v1). Within /v1, changes are additive only: new endpoints, new optional fields, new event types, new values in enums marked x-extensible-enum. Ignore fields you do not know, and treat unknown enum values as “other”.
  • A breaking change ships as /v2. A deprecated operation answers with Deprecation and Sunset headers at least 6 months before removal.
  • The contract version is info.version of openapi.yaml. While the API is in beta it is 1.0.0-draft.N.
  • The SDK’s version follows it: 0.N.x for contract draft N; from contract 1.x on, the SDK’s major and minor follow the contract’s. See the changelog.