OfferCue

API policy

OfferCue versioning and deprecation.

Agents should be able to integrate against a stable contract and know when a breaking change is coming.

Current version

The current REST surface is /api/v1. Backward-compatible additions may be made within v1. Breaking changes require a new versioned path such as /api/v2.

Deprecation and Sunset

When a version or endpoint is deprecated, OfferCue will publish a notice in this policy and the developer portal, add a Deprecation response header, and provide a Sunset response header with the planned retirement date. The notice will identify the replacement and migration deadline.

No current v1 endpoint is marked deprecated. Agents should not infer deprecation from a temporary error or from a normal rate-limit response.

Integration guidance

  • Read the OpenAPI contract rather than scraping HTML examples.
  • Respect Deprecation, Sunset, RateLimit-Reset and Retry-After when present.
  • Keep the API version in configuration so a migration can be tested before retirement.