Sign in
Pipelines

Trigger pipeline

Triggers a pipeline run manually, outside of the normal schedule. The pipeline fetches new data from the source and processes it through the agent. Returns the created run.

post/v2/pipelines/{pipeline_key}/trigger

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 to trigger.

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

The created pipeline run.

idstring required

The unique identifier for a pipeline run.

pipeline_keystring required

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

agent_keystring required

A unique key that identifies an agent.

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

The status of a pipeline run.

trigger_type'scheduled' | 'manual' | 'retry' required

What initiated the pipeline run.

records_fetchedinteger required

Number of records this run took from the source for processing, counting both upserts and deletions. Records the run drops before processing, for example source-reported deletions during a full refresh, are excluded. A retry run counts the dead letters it fetches.

records_processedinteger required

Number of records successfully processed by the agent. Excludes records counted by records_skipped.

records_skippedinteger required

Number of records the run neither processed nor failed. Either the agent's run_condition evaluated to false, so no session was created, or the judge agent's run_condition evaluated to false, so nothing verified the record. Disjoint from records_processed and records_failed.

records_failedinteger required

Number of records that failed processing.

errorstring nullable

Error details if the run failed.

started_atstring date-time nullable

When the run started executing.

completed_atstring date-time nullable

When the run finished.

created_atstring date-time required

When the run was created.

Example response

{
  "id": "run_pip_abc_manual_550e8400",
  "pipeline_key": "sharepoint-legal-ingest",
  "agent_key": "customer_support"
}

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