Skip to content
Sluice

triggerFlow

POST
/api/v1/flows/{namespace}/{flowId}/executions
curl --request POST \
  --url https://example.com/api/v1/flows/example/example/executions \
  --header 'Content-Type: application/json' \
  --data '{ "inputs": { "additionalProperty": "example" }, "labels": { "additionalProperty": "example" } }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
namespace
required
string
<= 128 characters /^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$/
flowId
required
string
<= 63 characters /^[a-z0-9][a-z0-9-]*$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
inputs
object
key
additional properties
labels
object
<= 20 properties
key
additional properties
string
<= 256 characters
key
additional properties
any
Examplegenerated
{
  "inputs": {
    "additionalProperty": "example"
  },
  "labels": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Created

Media typeapplication/json
object
chain_depth
required
integer format: int64
children
required
Array<object>
object
created_at
required
string format: date-time
id
required
string
state
required
string
key
additional properties
any
created_at
required
string format: date-time
created_by
required
string
duration_ms
integer | null format: int64
ended_at
string | null format: date-time
error
required
string
flow_id

Flow ID. Null for file runs.

string | null
flow_revision_id
string | null
git_sha
string
id
required
string
inputs
required
object
key
additional properties
labels
required
object
key
additional properties
string
namespace
required
string
outputs
object | null
parent_execution_id
string | null
reason
required
string
restart_of_id
string | null
secret_keys_used
required
Array<string>
snapshot_id
required
string
snapshot_version
integer | null format: int64
started_at
string | null format: date-time
state
required
string
Allowed values: QUEUED RUNNING CANCELLING SUCCESS FAILED TIMED_OUT CANCELLED SKIPPED
task_runs
required
Array<object>
object
attempt
required
integer format: int64
child_execution_id
string | null
duration_ms
integer | null format: int64
ended_at
string | null format: date-time
error
required
string
executor_type
required
string
exit_code
integer | null format: int64
id
required
string
outputs
object | null
pool
required
string
queued_at
string | null format: date-time
reason
required
string
reused_from_id
string | null
started_at
string | null format: date-time
state
required
string
Allowed values: PENDING QUEUED RUNNING SUCCESS FAILED TIMED_OUT CANCELLED SKIPPED
task_key
required
string
task_type
required
string
key
additional properties
any
trigger_payload
required
object
key
additional properties
trigger_type
required
string
key
additional properties
any
Example
{
  "state": "QUEUED",
  "task_runs": [
    {
      "state": "PENDING"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/json
object
error
required
object
code
required
string
details
message
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}