API

Versionierung und Rate Limits

Wie die öffentliche Everyn-API versioniert ist, wie Deprecation signalisiert wird und wie Clients Rate-Limit-Header lesen sollen.

Die öffentliche Everyn-HTTP-API ist im URL-Pfad versioniert. Die aktuelle Fläche ist /v1. Authentifizierte Produktaufrufe gehen an https://api.everyn.ai, nicht an diese Website.

Versionierung

Breaking Changes erscheinen unter einem neuen Pfadpräfix wie /v2. Additive, abwärtskompatible Änderungen können auf dem aktuellen Präfix ohne Versionswechsel erscheinen. Clients sollten sich an ein Präfix binden, nicht an eine unversionierte Wurzel.

Deprecation und Sunset

Wenn eine Operation oder ein Feld auf einem veröffentlichten Präfix entfernt wird, kündigt Everyn das zuerst in der Dokumentation an und dann in der Response nach RFC 9745 Structured Fields:

  • Deprecation: @1688169599 trägt den Unix-Zeitstempel des Deprecation-Datums. Der boolesche Wert true ist keine gültige Syntax.
  • Sunset trägt das HTTP-Datum, nach dem die Operation entfernt werden kann.
  • Diese Seite bleibt der Policy-Record. Agents sollen ein dokumentiertes Sunset-Datum als verbindlich behandeln, auch wenn ein gecachter Client die alte Operation noch aufruft.

Solange für eine /v1-Operation kein Sunset-Datum veröffentlicht ist, bleibt sie auf https://api.everyn.ai aufrufbar.

Rate Limits

Dieser Dokumentations-Origin erzwingt kein Request-Kontingent und sendet keine RateLimit-Header. Die Produkt-API kann 429 mit Retry-After zurückgeben, wenn Admission oder Provider-Kapazität erschöpft ist. Retry erst nach dieser Wartezeit. Keine Busy-Loops.

Das OpenAPI-Artefakt unter /openapi.json und /openapi/everyn-public-api.json ist der typisierte Vertrag für /v1.