List flow instances
curl --request GET \
--url https://{api_endpoint}/v1/orchestrate/flows/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_endpoint}/v1/orchestrate/flows/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_endpoint}/v1/orchestrate/flows/', 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/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_endpoint}/v1/orchestrate/flows/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{api_endpoint}/v1/orchestrate/flows/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_endpoint}/v1/orchestrate/flows/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{}
]{
"data": {
"message": "<string>"
}
}{
"data": {
"message": "<string>"
}
}Flows
List flow instances
List flow instances
curl --request GET \
--url https://{api_endpoint}/v1/orchestrate/flows/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_endpoint}/v1/orchestrate/flows/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_endpoint}/v1/orchestrate/flows/', 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/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_endpoint}/v1/orchestrate/flows/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{api_endpoint}/v1/orchestrate/flows/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_endpoint}/v1/orchestrate/flows/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{}
]{
"data": {
"message": "<string>"
}
}{
"data": {
"message": "<string>"
}
}List agentic workflow runs and retrieve execution details. Pass an
instance_id parameter to track execution progress until completion.
The following Python code sample demonstrates how you query the status of a specific agentic workflow instance until 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.
Query Parameters
Available options:
completed, in_progress, interrupted, failed Response
Flow runs return.
⌘I