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.
| Bereich | Beschreibung |
|---|---|
| Alert Rules | Event-based alert rules and public-safe alert delivery inspection. |
| Dataset Uploads | CSV dataset intake. Direct multipart uploads are limited to 25 MiB and return 202 DatasetUpload resources for async processing. |
| Datasets | Dataset read models. Use /v1/dataset-uploads for CSV intake. |
| Exports | Self-starting CSV exports. Clients create, poll/list/read, and download ready exports through the API. |
| Health | Unauthenticated operational readiness checks. |
| Job Specs | Reusable job specs and immutable job-spec versions. |
| Models | Product model catalog. Reads require job_specs:read; job-spec create/update still validates model IDs against this catalog. |
| Organization Admin | Browser-admin routes for organizations, members, invitations, API-key management, and audit events. API keys cannot call these admin routes. |
| Runs | Managed run creation, start/cancel/retry, rows, events, outputs, failures, and resolved retry-lineage results. |
| Webhooks | Webhook endpoint management, one-time signing-secret display/rotation, test deliveries, and public-safe delivery inspection. |