API overview | everyn

The Everyn API is designed for durable run control. Clients create datasets and job specs, start runs, inspect outcomes, manage webhooks and exports, and receive stable public error responses.

API docs map

Start with the guide pages when building an integration:

Area	Purpose
Authentication	Bearer credentials, organizations, scopes, and auth failures.
Idempotency	Safe create retries without duplicating product work.
Pagination	Cursor pagination and list-response shape.
API errors	Error envelope, status/code meanings, and recovery rules.
Quickstart	First successful workflow from API key to dataset, job spec, sample run, inspection, and export.
Dataset uploads	Public CSV intake, processing states, and upload failures.
Webhooks	Endpoint setup, signing, delivery inspection, and secret handling.
Generated reference	OpenAPI-backed reference pages generated from the FastAPI schema.

Initial public API surfaces:

Surface	Purpose
Datasets	Register and upload CSV-backed data sources.
Job specs	Define reusable run instructions and output expectations.
Runs	Start, inspect, retry, and export managed work.
Organizations	Manage membership, invitations, and API keys.
Webhooks	Configure delivery of run and result events.

The raw OpenAPI schema is published at /openapi/everyn-public-api.json for code generation, contract tests, and client tooling.

Every public error includes:

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