Asynchronously run the latest flow version
curl --request POST \
--url https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"AnyValue": {}
}'import requests
url = "https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async"
payload = { "AnyValue": {} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({AnyValue: {}})
};
fetch('https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'AnyValue' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async"
payload := strings.NewReader("{\n \"AnyValue\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"AnyValue\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"AnyValue\": {}\n}"
response = http.request(request)
puts response.read_body{
"instance_id": "<string>"
}{
"data": {
"message": "<string>"
}
}{
"data": {
"message": "<string>"
}
}{
"data": {
"message": "<string>"
}
}{
"data": {
"message": "<string>"
}
}Flows
Asynchronously run the latest flow version
Asynchronously run the latest “published” version of a flow with a given flow id.
Asynchronously run the latest flow version
curl --request POST \
--url https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"AnyValue": {}
}'import requests
url = "https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async"
payload = { "AnyValue": {} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({AnyValue: {}})
};
fetch('https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'AnyValue' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async"
payload := strings.NewReader("{\n \"AnyValue\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"AnyValue\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_endpoint}/v1/orchestrate/flows/{flow_id}/run/async")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"AnyValue\": {}\n}"
response = http.request(request)
puts response.read_body{
"instance_id": "<string>"
}{
"data": {
"message": "<string>"
}
}{
"data": {
"message": "<string>"
}
}{
"data": {
"message": "<string>"
}
}{
"data": {
"message": "<string>"
}
}After you start an agentic workflow, you can use the returned
instance_id to poll for status updates until completion.
The following Python code sample demonstrates how you start an agentic workflow asynchronously and poll for completion:
Example
"""
Simple example of calling a watsonx Orchestrate flow asynchronously.
"""
import time
import requests
def run_flow_async(api_endpoint, api_key, flow_id, input_data):
"""Start an async flow execution and return the instance ID."""
url = f"{api_endpoint}/api/v1/orchestrate/flows/{flow_id}/run/async"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
response = requests.post(url, headers=headers, json=input_data)
response.raise_for_status()
result = response.json()
instance_id = result.get("instance_id")
print(f"Flow started with instance ID: {instance_id}")
return instance_id
def wait_for_completion(api_endpoint, api_key, flow_id, instance_id):
"""Poll the flow instance status until it completes."""
url = f"{api_endpoint}/api/v1/orchestrate/flows/{flow_id}/instances"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
# Filter by instance_id
params = {"instance_id": instance_id}
while True:
response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
instances = response.json().get("instances", [])
if instances:
instance = instances[0] # Should only be one with the filter
status = instance.get("status", "").lower()
print(f"Status: {status}")
if status == "completed":
print("Flow completed successfully!")
return instance
elif status == "failed":
raise RuntimeError(f"Flow failed: {instance.get('error')}")
time.sleep(5) # Poll every 5 seconds
# Example usage
if __name__ == "__main__":
api_endpoint = "https://your-instance.watson-orchestrate.ibm.com"
api_key = "your-api-key"
flow_id = "your-flow-id"
input_data = {"message": "Hello, World!"}
# Start the flow
instance_id = run_flow_async(api_endpoint, api_key, flow_id, input_data)
# Wait for completion
result = wait_for_completion(api_endpoint, api_key, flow_id, instance_id)
print(f"Final result: {result}")
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The watsonx Orchestrate message thread id.
The flow execution instance id. Only use this if you want to resume a previous flow execution.
The callback url for sending the flow output
Path Parameters
The flow id
Body
application/json
The output defined by the flow model
Callbacks
Response
The flow execution request accepted.
The flow instance id
⌘I