Ceevee
CeeveeDocs

API Reference

Versioning

URL major versions and date-pinned API versions.

We never make breaking changes inside a major version. New fields, new endpoints, and new event types are additive and may appear at any time. Behavioural changes that change response shape, validation, or defaults are gated behind a date-pinned API version header.

Pinning a version

Send Ceevee-Api-Version: YYYY-MM-DD on every request. The current default version is shown in the response header of the same name.

curl https://api.ceevee.cc/v1/jobs \
  -H 'Authorization: Bearer ceevee_sk_live_…' \
  -H 'Ceevee-Api-Version: 2026-04-27'

What we promise

  • We will not remove fields from a pinned version without a 12-month deprecation window.
  • We will not change the meaning of an existing field within a pinned version.
  • We will not require new fields on existing endpoints within a pinned version.

Upgrading

Read the changelog page for what changed between versions. Test in the sandbox by sending the new date in Ceevee-Api-Version. When you are ready, update the pinned version on your tokens.