API-Übersicht

Die Everyn-API ist für dauerhafte Run-Steuerung gebaut. Clients erstellen Datensätze und Job Specs, starten Runs, prüfen Ergebnisse, verwalten Webhooks und Exports und erhalten stabile öffentliche Fehlerantworten.

API-Dokumentationskarte

Beginne mit den Guide-Seiten, wenn du eine Integration baust:

Bereich	Zweck
Authentifizierung	Bearer Credentials, Organisationen, Scopes und Auth-Fehler.
Idempotenz	Sichere Create-Retries ohne doppelte Produktarbeit.
Pagination	Cursor Pagination und List-Response-Form.
API-Fehler	Error Envelope, Status-/Code-Bedeutungen und Recovery-Regeln.
Quickstart	Erster erfolgreicher Workflow von API Key über Dataset, Job Spec, Sample Run, Prüfung und Export.
Dataset Uploads	Öffentlicher CSV-Intake, Processing States und Upload-Fehler.
Webhooks	Endpoint-Setup, Signing, Delivery-Inspektion und Secret Handling.
Generierte Referenz	OpenAPI-gestützte Referenzseiten, generiert aus dem FastAPI-Schema.

Erste öffentliche API-Bereiche:

Bereich	Zweck
Datasets	CSV-basierte Datenquellen registrieren und hochladen.
Job Specs	Wiederverwendbare Run-Anweisungen und Ausgabeerwartungen definieren.
Runs	Verwaltete Arbeit starten, prüfen, wiederholen und exportieren.
Organizations	Mitgliedschaften, Einladungen und API Keys verwalten.
Webhooks	Zustellung von Run- und Ergebnisereignissen konfigurieren.

Das rohe OpenAPI-Schema wird unter /openapi/everyn-public-api.json für Codegenerierung, Contract Tests und Client-Tools veröffentlicht.

Jeder öffentliche Fehler enthält:

{
  "error": {
    "status": 422,
    "code": "validation_failed",
    "message": "Request validation failed.",
    "requestId": "req_example",
    "docsUrl": "https://www.geteveryn.com/de/docs/errors/validation_failed",
    "fieldErrors": []
  }
}