v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
Flows

Run the latest flow version

Run the latest "published" version of a flow with a given flow ID.

post/v1/orchestrate/flows/{flow_id}/run

Path parameters

flow_idstring required

The flow id

Query parameters

request_timeoutnumber

The flow request timeout.

Headers

x-ibm-thread-idstring

The ID of the thread where the flow was started

x-ibm-environment-idstring

The target environment ID - draft or live

x-ibm-agent-idstring

The caller agent id

x-ibm-agent-versionstring

The caller agent version

x-ibm-flow-execution-summaryboolean

Generate the flow execution summary. Default to false.

Request body

object required

The input defined by the flow model

Response

The flow execution is completed.

AnyValueobject

The output defined by the flow model