Skip to content

Trigger pipeline execution

POST
/pipelines/{pipelineId}/trigger
pipelineId
required

Unique identifier of the pipeline to retrieve

string

Unique identifier of the pipeline to retrieve

object
input

Runtime input data for the pipeline execution

object
files

Map of file slot IDs to file ID(s) - array if multiple: true

object
key
additional properties
Any of:

A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)

string
datasets

Map of dataset slot IDs to table ID(s) - array if multiple: true

object
key
additional properties
Any of:

A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)

string
dataInputs

Map of data input slot IDs to their values

object
key
additional properties
nullable

Pipeline execution triggered successfully. For streaming pipelines (streaming_language_model), poll GET /pipeline-executions/:executionId to retrieve handlerOutput.streamingChannelId before subscribing to the SSE stream.

object
executionId
required

Unique identifier for the created execution

string
status
required

Initial status of the execution (typically ‘pending’)

string
createdAt
required

When the execution was created (ISO 8601)

string format: date-time

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean

Conflict - Resource already exists or operation conflicts with current state

object
error
required
string
code
string
details
nullable
retryable
boolean