Skip to main content
POST
/
v1
/
workflow
Execute workflow
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": {}
}
'
"<string>"

Headers

​
authorization
string
required
Pattern: ^Bearer [\s\S]{0,}$

Body

​
workflow_name
string
required

Name of the workflow to execute

Minimum string length: 1
​
message
any
required

User message in IlluminaUIMessage format with parts array; see the type IlluminaUIMessage from @illuminalab/react-ui

​
thread_id
string<uuid>
required

UUID of the conversation thread

Pattern: ^([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)$
​
resource_id
string
required

Unique resource identifier (min 10 chars, no whitespace)

Minimum string length: 10
Pattern: ^\S+$
​
metadata
object

Optional key-value metadata for workflow configuration

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.