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. 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/runs | List Runs | Bearer token (BearerAuth) | None. | 200 application/json: Page_RunResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/runs | Create Run | Bearer token (BearerAuth) | application/json: RunCreateRequestBody | 201 application/json: RunResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id} | Get Run | Bearer token (BearerAuth) | None. | 200 application/json: RunResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/runs/{run_id}/cancel | Cancel Run | Bearer token (BearerAuth) | None. | 200 application/json: RunResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/events | List Run Events | Bearer token (BearerAuth) | None. | 200 application/json: Page_RunEventResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/failures | List Run Failures | Bearer token (BearerAuth) | None. | 200 application/json: Page_FailureResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/failures/{run_row_id} | Get Run Failure | Bearer token (BearerAuth) | None. | 200 application/json: FailureResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/outputs | List Run Outputs | Bearer token (BearerAuth) | None. | 200 application/json: Page_OutputListItemResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/outputs/{output_id} | Get Run Output | Bearer token (BearerAuth) | None. | 200 application/json: OutputDetailResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/resolved-results | Get Resolved Run Results | Bearer token (BearerAuth) | None. | 200 application/json: ResolvedResultsResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/runs/{run_id}/resume | Resume Run | Bearer token (BearerAuth) | None. | 200 application/json: RunResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/runs/{run_id}/retry | Create Retry Run | Bearer token (BearerAuth) | None. | 201 application/json: RunResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/rows | List Run Rows | Bearer token (BearerAuth) | None. | 200 application/json: Page_RunRowResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/rows/{dataset_row_id}/history | Get Row History | Bearer token (BearerAuth) | None. | 200 application/json: RowHistoryPageResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/rows/{dataset_row_id}/history/content/{handle} | Get Row History Content | Bearer token (BearerAuth) | None. | 200 application/json: RowHistoryContentResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/rows/{dataset_row_id}/history/tail | Get Row History Tail | Bearer token (BearerAuth) | None. | 200 application/json: RowHistoryPageResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/runs/{run_id}/rows/{run_row_id} | Get Run Row | Bearer token (BearerAuth) | None. | 200 application/json: RunRowDetailResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/runs/{run_id}/start | Start Run | Bearer token (BearerAuth) | None. | 200 application/json: RunResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
Loading API reference...