curl --request POST \
--url https://api.illuminalab.com/v1/workflow/ \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"workflow_name": "<string>",
"message": "<unknown>",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource_id": "<string>",
"metadata": {}
}
'import requests
url = "https://api.illuminalab.com/v1/workflow/"
payload = {
"workflow_name": "<string>",
"message": "<unknown>",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource_id": "<string>",
"metadata": {}
}
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflow_name: '<string>',
message: '<unknown>',
thread_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
resource_id: '<string>',
metadata: {}
})
};
fetch('https://api.illuminalab.com/v1/workflow/', 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.illuminalab.com/v1/workflow/",
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([
'workflow_name' => '<string>',
'message' => '<unknown>',
'thread_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'resource_id' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$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.illuminalab.com/v1/workflow/"
payload := strings.NewReader("{\n \"workflow_name\": \"<string>\",\n \"message\": \"<unknown>\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resource_id\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<authorization>")
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.illuminalab.com/v1/workflow/")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_name\": \"<string>\",\n \"message\": \"<unknown>\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resource_id\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.illuminalab.com/v1/workflow/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_name\": \"<string>\",\n \"message\": \"<unknown>\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resource_id\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body"<string>"{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Execute workflow
Execute a named workflow with the provided message and stream SSE events back. Returns a Server-Sent Events stream following the AI SDK UI Message protocol. The stream includes assistant messages, tool calls, and tool results.
curl --request POST \
--url https://api.illuminalab.com/v1/workflow/ \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"workflow_name": "<string>",
"message": "<unknown>",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource_id": "<string>",
"metadata": {}
}
'import requests
url = "https://api.illuminalab.com/v1/workflow/"
payload = {
"workflow_name": "<string>",
"message": "<unknown>",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource_id": "<string>",
"metadata": {}
}
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflow_name: '<string>',
message: '<unknown>',
thread_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
resource_id: '<string>',
metadata: {}
})
};
fetch('https://api.illuminalab.com/v1/workflow/', 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.illuminalab.com/v1/workflow/",
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([
'workflow_name' => '<string>',
'message' => '<unknown>',
'thread_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'resource_id' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$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.illuminalab.com/v1/workflow/"
payload := strings.NewReader("{\n \"workflow_name\": \"<string>\",\n \"message\": \"<unknown>\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resource_id\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<authorization>")
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.illuminalab.com/v1/workflow/")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_name\": \"<string>\",\n \"message\": \"<unknown>\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resource_id\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.illuminalab.com/v1/workflow/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_name\": \"<string>\",\n \"message\": \"<unknown>\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resource_id\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body"<string>"{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Headers
^Bearer [\s\S]{0,}$Body
Name of the workflow to execute
1User message in IlluminaUIMessage format with parts array; see the type IlluminaUIMessage from @illuminalab/react-ui
UUID of the conversation thread
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Unique resource identifier (min 10 chars, no whitespace)
10^\S+$Optional key-value metadata for workflow configuration
Show child attributes
Show child attributes
Response
Server-Sent Events stream following the AI SDK UI Message protocol. Format: 'event: \ndata: \n\n' for each event.
Server-Sent Events stream following the AI SDK UI Message protocol. Format: 'event: \ndata: \n\n' for each event.