pipelines_Pipeline Runs

Update a Pipeline Run

Updates a Pipeline Run for a specific pipeline.

Send a PUT request with a new status value to transition the run programmatically; the request body accepts a single status field using the same enum values as the run lifecycle (pending, queued, processing, running, waiting, complete, success, failure, cancelled, invalid, timeout), and the response returns the updated Pipeline Run object.

About Pipeline Runs

A Pipeline Run is the record created each time a Pipeline executes, progressing through Esper's orchestration lifecycle from PENDING through QUEUED, PROCESSING, RUNNING, and WAITING to COMPLETE with a SUCCESS or FAILURE outcome (or CANCELLED, TIMEOUT after 21 days, or INVALID if the pipeline has zero stages). Each Pipeline Run produces one Stage Run per stage in the pipeline.

Key Fields / Query Parameters

  • status — the lifecycle status to set on the run

Common Use Cases

  • Cancel an in-progress Pipeline Run by setting status to cancelled
put/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/

Request

  • Base URL
    https://develop-api.esper.cloud/api
  • URL
    https://develop-api.esper.cloud/api/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/
  • Auth
    HTTP bearer

Path parameters

pipeline_idstring required

ID of the Pipeline

pipeline_run_idstring required

Run id of pipeline run

Request body

status'pending' | 'queued' | 'processing' | 'running' | 'waiting' | 'complete' | 'success' | 'failure' | 'cancelled' | 'invalid' | 'timeout'

Response

Updated Pipeline run information

codeinteger
messagestring

Changes

No recorded changes to this operation across all 6 revisions of this API.