Versioning and rate limits
How the Everyn public API is versioned, how deprecation is signaled, and how clients should read rate-limit headers.
The Everyn public HTTP API is versioned in the URL path. The current surface is /v1. Authenticated product calls go to https://api.everyn.ai, not this website.
Versioning
Breaking changes ship under a new path prefix such as /v2. Additive, backward-compatible changes may appear on the current prefix without a version bump. Clients should bind to a prefix, not to an unversioned root.
Deprecation and sunset
When an operation or field on a published prefix will be removed, Everyn advertises that in docs first and then on the response using RFC 9745 Structured Fields:
Deprecation: @1688169599carries the Unix timestamp of the deprecation date. The boolean valuetrueis not valid syntax.Sunsetcarries the HTTP date after which the operation may be removed.- This page remains the policy record. Agents should treat a documented sunset date as authoritative even if a cached client still calls the old operation.
Until a sunset date is published for a /v1 operation, that operation stays callable on https://api.everyn.ai.
Rate limits
This documentation origin does not enforce a request quota and does not emit RateLimit headers. The product API may return 429 with Retry-After when admission or provider capacity is exhausted. Retry only after that delay. Do not busy-loop.
The OpenAPI artifact at /openapi.json and /openapi/everyn-public-api.json is the typed contract for /v1.