Skip to main content
POST
/
v1
/
orchestrate
/
flows
/
{flow_id}
/
run
Run the latest flow version
curl --request POST \
  --url https://{api_endpoint}/api/v1/orchestrate/flows/{flow_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "AnyValue": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-ibm-thread-id
string

The ID of the thread where the flow was started

​
x-ibm-environment-id
string

The target environment ID - draft or live

​
x-ibm-agent-id
string

The caller agent id

​
x-ibm-agent-version
string

The caller agent version

​
x-ibm-flow-execution-summary
boolean

Generate the flow execution summary. Default to false.

Path Parameters

​
flow_id
string
required

The flow id

Query Parameters

​
request_timeout
number
default:60000

The flow request timeout.

Body

application/json

The input defined by the flow model

Response

The flow execution is completed.

​
AnyValue
object

The output defined by the flow model