Pipelines

Run a Spec as a pipeline

Compiles the named Spec's saved rail into a pipeline and starts processing the documents in one call. The Spec must have a composed rail; otherwise a 400 is returned (use POST /v1/jobs for an ad-hoc run with no rail). Requires write scope.

post/v1/pipelines

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/pipelines
  • Auth: HTTP bearer

Request body

schema_idstring uuid required

The Spec to run (a user_schema with a composed rail).

document_idsstring[] required
namestring
pipeline_mode'new' | 'append'

Explicit override of the Spec's configured pipeline mode. append adds the documents to the newest eligible existing pipeline on the Spec (config-matching, under the size cap) instead of creating one; the response's appended reports which happened. Omitted → the Spec's own setting (default new).

Response

Created pipeline run with links to progress + data-product. appended: true marks an append-mode reuse of an existing pipeline (its id is returned). run_id is the submission-group identifier stamped on this call's documents — usable as the run_id filter on the results/documents reads.

Changes

No recorded changes to this operation across all 1 revision of this API.