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.
Endpoint summary for quick scanning before using the generated reference:
Failures use the PublicErrorEnvelope shape with an X-Request-Id header. Most endpoints below return 400, 401, 403, 404, 409, 422, 429; the few that differ list their own statuses in the table, which otherwise shows only success responses. See API errors for the envelope and recovery patterns.
| Method | Path | Summary | Request body | Success response |
|---|---|---|---|---|
GET | /v1/exports | List Exports | None. | 200 application/json: Page_ExportResponse_ |
GET | /v1/exports/{export_id} | Get Export | None. | 200 application/json: ExportResponse |
GET | /v1/exports/{export_id}/download | Download Export | None. | 200 text/csv: stringErrors: 400, 401, 403, 404, 409, 410, 422, 429. |
GET | /v1/runs/{run_id}/exports | List Run Exports | None. | 200 application/json: Page_ExportResponse_ |
POST | /v1/runs/{run_id}/exports | Create Export | application/json: ExportCreateRequestBody | 201 application/json: ExportResponse |
Loading API reference...