Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Pipeline Dead Letters

Process dead letters

Processes dead letters by creating a new pipeline run. The run re-fetches the specified records from the source and sends them through the agent. A request without filters processes all pending dead letters.

post/v2/pipelines/{pipeline_key}/dead_letters/process

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.

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.

Request body

source_record_idsstring[]

Specific source record IDs to process. If omitted, processes all matching dead letters.

last_run_idstring

The unique identifier for a pipeline run.

origin'pipeline' | 'manual'

How this dead letter was created.

Example request

{
  "last_run_id": "run_pip_abc_manual_550e8400"
}

Response

The created retry 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 discovered from the source in this run.

records_processedinteger required

Number of records successfully processed by the agent.

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"
}