APIReferenz

API-Referenz

Generierte öffentliche OpenAPI-Referenz für die Everyn-API.

Überblick

Diese API-Referenz wird aus dem eingecheckten FastAPI-OpenAPI-Schema generiert. Sie ist nach OpenAPI-Tags gegliedert, damit Methode, Pfad, Request-Form, Response-Form und Fehlermodell pro Produktbereich zusammenstehen.

API-Bereiche

Nutze die Tag-Seiten unten für Endpoint-Details. Das Schema-Artefakt wird auch unter /openapi/everyn-public-api.json veröffentlicht, falls ein Tool direkt OpenAPI einlesen soll.

BereichBeschreibung
Alert RulesEreignisbasierte Alert-Regeln und sichere Einsicht in Alert-Zustellungen.
BillingOrganisationsbezogene Abfragen zur menschlichen Abrechnung sowie Abrechnungsänderungen durch Eigentümer und Administratoren.
Dataset UploadsCSV-Datenimport. Direkte Multipart-Uploads sind auf 25 MiB begrenzt und liefern DatasetUpload-Ressourcen mit Status 202 für die asynchrone Verarbeitung zurück.
DatasetsDatenmodelle für Dataset-Abfragen. Für CSV-Importe /v1/dataset-uploads verwenden.
ExportsSelbst startende CSV-Exporte. Clients erstellen, prüfen und lesen fertige Exporte und laden sie herunter; es gibt keine öffentliche Execute-Aktion.
HealthNicht authentifizierte Prüfungen der betrieblichen Bereitschaft.
Job SpecsWiederverwendbare Job-Spezifikationen und unveränderliche Versionen von Job-Spezifikationen.
ModelsKatalog der Produktmodelle. Lesezugriffe erfordern job_specs:read; beim Erstellen und Aktualisieren von Job-Spezifikationen werden Modell-IDs weiterhin gegen diesen Katalog validiert.
Organization AdminBrowser-Admin-Endpunkte für Organisationen, Mitglieder, Einladungen, API-Schlüsselverwaltung und Audit-Ereignisse. API-Schlüssel können diese Admin-Endpunkte nicht aufrufen.
RunsVerwaltete Runs: Erstellen, Starten/Abbrechen/Wiederholen sowie Rows, Events, Outputs, Fehler und aufgelöste Ergebnisse aus Retry-Linien.
UsageAbfragen zu Organisationsnutzung und Guthaben: Workspace-Nutzungsübersicht im Browser und maschinenlesbare Vorabprüfung des Managed-AI-Guthabens (runs:read). Das ausführungssichere Guthaben ist ein Hinweis; die Abrechnung erfolgt asynchron nach Abschluss der Runs.
WebhooksVerwaltung von Webhook-Endpunkten, einmalige Anzeige und Rotation von Signaturgeheimnissen, Testzustellungen und sichere Einsicht in Zustellungen.