Start a pipeline run
Start processing the attached dataset, up to 10,000 items. Returns the run to poll. Configuration errors, failed checks, and unfinished lints on nodes from Start to End block deployment with 400. Missing lints and exam-dataset lints with findings are started when deployment is rejected; retry after they finish. Restart failed lints with POST /api/v2-beta/pipelines/{pipelineId}/lints.
Authorizations
Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.
Path Parameters
Pipeline ID with prefix pl..
^pl\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Body
The body is of type object.
Response
Run started
A pipeline run job. Poll until status is succeeded or failed.
Time the run was created, as an ISO 8601 timestamp.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Dataset ID with prefix ds..
^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Deployment failure message, or null when the run deployed successfully.
Pipeline run ID with prefix plr..
^plr\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Counts of items and their current outcomes.
Run state: pending before deployment, running while processing, succeeded when processing ends, or failed if deployment fails; individual item failures are counted in result.
pending, running, succeeded, failed