APIReference
Runs API
Generated OpenAPI reference for the Runs API surface.
Overview
Runs endpoints are part of the public Everyn API. Managed run creation, start/cancel/retry, rows, events, outputs, failures, and resolved retry-lineage results.
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/runs | List Runs | None. | 200 application/json: Page_RunResponse_ |
POST | /v1/runs | Create Run | application/json: RunCreateRequestBody | 201 application/json: RunResponse |
GET | /v1/runs/{run_id} | Get Run | None. | 200 application/json: RunResponse |
POST | /v1/runs/{run_id}/cancel | Cancel Run | None. | 200 application/json: RunResponse |
GET | /v1/runs/{run_id}/events | List Run Events | None. | 200 application/json: Page_RunEventResponse_ |
GET | /v1/runs/{run_id}/failures | List Run Failures | None. | 200 application/json: Page_FailureResponse_ |
GET | /v1/runs/{run_id}/failures/{run_row_id} | Get Run Failure | None. | 200 application/json: FailureResponse |
GET | /v1/runs/{run_id}/outputs | List Run Outputs | None. | 200 application/json: Page_OutputListItemResponse_ |
GET | /v1/runs/{run_id}/outputs/{output_id} | Get Run Output | None. | 200 application/json: OutputDetailResponse |
GET | /v1/runs/{run_id}/resolved-results | Get Resolved Run Results | None. | 200 application/json: ResolvedResultsResponse |
POST | /v1/runs/{run_id}/resume | Resume Run | None. | 200 application/json: RunResponse |
POST | /v1/runs/{run_id}/retry | Create Retry Run | None. | 201 application/json: RunResponse |
GET | /v1/runs/{run_id}/rows | List Run Rows | None. | 200 application/json: Page_RunRowResponse_ |
GET | /v1/runs/{run_id}/rows/{run_row_id} | Get Run Row | None. | 200 application/json: RunRowDetailResponse |
POST | /v1/runs/{run_id}/start | Start Run | None. | 200 application/json: RunResponse |
Loading API reference...