APIReference
API reference
Generated public OpenAPI reference for the Everyn API.
Overview
This API reference is generated from the checked-in FastAPI OpenAPI schema. It is organized by OpenAPI tag so each product area has method, path, request, response, and error details in one place.
API areas
Use the tag pages below for endpoint-level details. The schema artifact is also published at /openapi/everyn-public-api.json for tools that prefer direct OpenAPI ingestion.
| Area | Description |
|---|---|
| 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. |