Sign in
Pipeline Dead Letters

Create dead letter

Manually adds a source record to the dead letter queue for reprocessing. Use this to force a record through the pipeline again, for example when the agent or judge made an incorrect decision.

post/v2/pipelines/{pipeline_key}/dead_letters

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_idstring required

The identifier for the source record to add. Format depends on connector type:

  • S3: the object key (e.g. legal/contracts/doc.pdf)
  • SharePoint: the drive item ID
  • Google Drive: the file ID
  • Box: the file ID (e.g. 1422162456741)
  • Wolken: the article number (e.g. 345678)
  • Confluence: the page ID (e.g. 123456789)
  • Web: the canonicalized URL (e.g. https://docs.example.com/page)
error_messagestring

Optional reason for manually adding this record.

operation'upsert' | 'delete'

The operation the source performed on a record. upsert when the record was added or changed, delete when the source reported it deleted. New values may be added; treat unrecognized values as opaque.

Response

The created dead letter.

idstring required

The unique identifier for this dead letter entry.

source_record_idstring required

The identifier for the source record. Format depends on connector type:

  • S3: the object key (e.g. legal/contracts/doc.pdf)
  • SharePoint: the drive item ID
  • Google Drive: the file ID
  • Box: the file ID (e.g. 1422162456741)
  • Wolken: the article number (e.g. 345678)
  • Confluence: the page ID (e.g. 123456789)
  • Web: the canonicalized URL (e.g. https://docs.example.com/page)
status'pending' | 'retrying' required

The status of a dead letter entry.

error_messagestring nullable

The error message from the most recent failed processing attempt.

last_run_idstring

The unique identifier for a pipeline run.

attempt_countinteger required

The number of times this record has been attempted.

origin'pipeline' | 'manual' required

How this dead letter was created.

operation'upsert' | 'delete' required

The operation the source performed on a record. upsert when the record was added or changed, delete when the source reported it deleted. New values may be added; treat unrecognized values as opaque.

created_atstring date-time required

When this dead letter was first recorded.

updated_atstring date-time nullable

When this dead letter was last updated.

Example response

{
  "id": "pdl_a1b2c3d4-e5f6-7890-abcd-ef0123456789",
  "last_run_id": "run_pip_abc_manual_550e8400"
}

Changes

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

  • c94fd099d78b2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added