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:
| Method | Path | Summary |
|---|---|---|
GET | /v1/runs | List Runs |
POST | /v1/runs | Create Run |
GET | /v1/runs/{run_id} | Get Run |
GET | /v1/runs/{run_id}/active-results/window | Get Active Run Results Window |
POST | /v1/runs/{run_id}/cancel | Cancel Run |
GET | /v1/runs/{run_id}/events | List Run Events |
GET | /v1/runs/{run_id}/failures | List Run Failures |
GET | /v1/runs/{run_id}/failures/{run_row_id} | Get Run Failure |
GET | /v1/runs/{run_id}/generated-results/resolve-target | Resolve Generated Result Target |
GET | /v1/runs/{run_id}/generated-results/row-target | Resolve Generated Result Target |
GET | /v1/runs/{run_id}/generated-results/window | Get Generated Results Window |
GET | /v1/runs/{run_id}/outputs | List Run Outputs |
GET | /v1/runs/{run_id}/outputs/{output_id} | Get Run Output |
GET | /v1/runs/{run_id}/resolved-results | Get Resolved Run Results |
GET | /v1/runs/{run_id}/resolved-results/resolve-target | Resolve Resolved Run Result Row Target |
GET | /v1/runs/{run_id}/resolved-results/row-target | Resolve Resolved Run Result Row Target |
GET | /v1/runs/{run_id}/resolved-results/window | Get Resolved Run Results Window |
GET | /v1/runs/{run_id}/resolved-results/{dataset_row_id}/generated-rows/row-target | Resolve Generated Row Target |
GET | /v1/runs/{run_id}/resolved-results/{dataset_row_id}/generated-rows/window | Get Generated Rows Window |
POST | /v1/runs/{run_id}/retry | Create Retry Run |
GET | /v1/runs/{run_id}/rows | List Run Rows |
GET | /v1/runs/{run_id}/rows/{run_row_id} | Get Run Row |
POST | /v1/runs/{run_id}/start | Start Run |
Loading API reference...