triggerFlow
POST
/api/v1/flows/{namespace}/{flowId}/executions
const url = 'https://example.com/api/v1/flows/example/example/executions';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"inputs":{"additionalProperty":"example"},"labels":{"additionalProperty":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
flowId
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
inputs
object
key
additional properties
labels
object
key
additional properties
string
key
additional properties
any
Examplegenerated
{ "inputs": { "additionalProperty": "example" }, "labels": { "additionalProperty": "example" }}Responses
Section titled “ Responses ”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
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
item
The item of a task with each. Absent for a task without each, and before the list is known.
item_index
required
Position of the item of a task with each. 0 for a task without each.
integer format: int64
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
task_key
required
string
task_type
required
string
wait
The question of a wait task. Set from the time the task waits.
object
fields
required
Array<object>
object
default
description
string
id
required
string
required
required
boolean
type
required
string
values
Array
key
additional properties
any
message
required
string
key
additional properties
any
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", "wait": { "fields": [ { "type": "string" } ] } } ]}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" }}