Sign in
Pipeline Runs

List pipeline runs

Lists execution runs for a pipeline, with optional filtering by status.

get/v2/pipelines/{pipeline_key}/runs

Path parameters

pipeline_keystring required

The unique key for the pipeline. You can provide the key, or the platform generates one.

Example:sharepoint-legal-ingest

The unique key of the pipeline.

Query parameters

status'running' | 'completed' | 'failed' | 'cancelled'

The status of a pipeline run.

Filter runs by status.

afterstring date-time

Only return runs created after this timestamp.

limitinteger

The maximum number of runs to return.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of pipeline runs.

Example response

{
  "runs": [
    {
      "id": "run_pip_abc_manual_550e8400",
      "pipeline_key": "sharepoint-legal-ingest",
      "agent_key": "customer_support"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}

Changes

Changed in 1 of the 13 revisions of this API.1

  • 83554494d7f81See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added