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>"
}
}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

