Exports API
Generated OpenAPI reference for the Exports API surface.
Overview
Exports endpoints are part of the public Everyn API. Self-starting CSV exports. Clients create, poll/list/read, and download ready exports through the API; there is no public execute action.
Endpoints
The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag. The static summary keeps the endpoint purpose, authentication, schema names, and API error guidance available before the interactive reference loads.
The details below are static HTML generated from the same OpenAPI schema, so they remain readable without client-side JavaScript. The interactive component after this section provides expandable examples and richer schema browsing.
Endpoint summary for quick scanning before using the generated reference:
| Method | Path | Purpose | Authentication | Request body / schema | Success response / schema | Errors |
|---|---|---|---|---|---|---|
GET | /v1/exports | List Exports | Bearer token (BearerAuth) | None. | 200 application/json: Page_ExportResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/exports/{export_id} | Get Export | Bearer token (BearerAuth) | None. | 200 application/json: ExportResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/exports/{export_id}/download | Download Export | Bearer token (BearerAuth) | None. | 200 text/csv: string | API errors: 400, 401, 403, 404, 409, 410, 422, 429 |
GET | /v1/runs/{run_id}/exports | List Run Exports | Bearer token (BearerAuth) | None. | 200 application/json: Page_ExportResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/runs/{run_id}/exports | Create Export | Bearer token (BearerAuth) | application/json: ExportCreateRequestBody | 201 application/json: ExportResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
Loading API reference...