Skip to main content
The OpenAPI document is the authority for EvalGate’s public API surface. Its info.version identifies the current contract. Operations and fields that are not in OpenAPI are not part of the public contract.

​
Version selection

Documented /api/* operations are the canonical paths. /api/v1/* is accepted as a compatibility alias, but the prefix does not expose undocumented routes. SDKs send these diagnostic headers on every request: Additive fields and operations can appear within the current surface. A breaking change requires a documented migration path and a new compatible surface or version.

​
Machine-readable deprecation signals

No published operation is currently scheduled for removal. When an operation is deprecated, EvalGate will:
  • mark it deprecated: true in OpenAPI;
  • publish its replacement and exact dates in the API changelog;
  • return an RFC 9745 Deprecation header;
  • return a Link header with rel="deprecation" to the migration guide; and
  • return an RFC 8594 Sunset header only after a shutdown date is scheduled.
The dates above demonstrate the header formats; they are not an announced sunset. EvalGate publishes operation-specific dates and does not currently promise a universal minimum migration window.

​
Client behavior

Agents should treat OpenAPI deprecated: true or the Deprecation response header as a signal to read the linked migration guide. They should stop creating new integrations against the deprecated operation and migrate before any published Sunset date. See also Errors, Authentication, and Rate limits.