Stream thread run
curl --request POST \
--url https://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"command": {
"resume": {
"decision": "approve"
}
},
"stream_mode": [
"values",
"messages-tuple",
"custom"
],
"stream_subgraphs": true,
"stream_resumable": true,
"assistant_id": "flowra-assistant",
"on_disconnect": "continue",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"model": "openai/gpt-4o-mini",
"reasoningEffort": "none"
}
'import requests
url = "https://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream"
payload = {
"command": { "resume": { "decision": "approve" } },
"stream_mode": ["values", "messages-tuple", "custom"],
"stream_subgraphs": True,
"stream_resumable": True,
"assistant_id": "flowra-assistant",
"on_disconnect": "continue",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"model": "openai/gpt-4o-mini",
"reasoningEffort": "none"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
command: {resume: {decision: 'approve'}},
stream_mode: ['values', 'messages-tuple', 'custom'],
stream_subgraphs: true,
stream_resumable: true,
assistant_id: 'flowra-assistant',
on_disconnect: 'continue',
workflowId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
model: 'openai/gpt-4o-mini',
reasoningEffort: 'none'
})
};
fetch('https://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream', 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://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream",
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([
'command' => [
'resume' => [
'decision' => 'approve'
]
],
'stream_mode' => [
'values',
'messages-tuple',
'custom'
],
'stream_subgraphs' => true,
'stream_resumable' => true,
'assistant_id' => 'flowra-assistant',
'on_disconnect' => 'continue',
'workflowId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'model' => 'openai/gpt-4o-mini',
'reasoningEffort' => 'none'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream"
payload := strings.NewReader("{\n \"command\": {\n \"resume\": {\n \"decision\": \"approve\"\n }\n },\n \"stream_mode\": [\n \"values\",\n \"messages-tuple\",\n \"custom\"\n ],\n \"stream_subgraphs\": true,\n \"stream_resumable\": true,\n \"assistant_id\": \"flowra-assistant\",\n \"on_disconnect\": \"continue\",\n \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"model\": \"openai/gpt-4o-mini\",\n \"reasoningEffort\": \"none\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"command\": {\n \"resume\": {\n \"decision\": \"approve\"\n }\n },\n \"stream_mode\": [\n \"values\",\n \"messages-tuple\",\n \"custom\"\n ],\n \"stream_subgraphs\": true,\n \"stream_resumable\": true,\n \"assistant_id\": \"flowra-assistant\",\n \"on_disconnect\": \"continue\",\n \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"model\": \"openai/gpt-4o-mini\",\n \"reasoningEffort\": \"none\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"command\": {\n \"resume\": {\n \"decision\": \"approve\"\n }\n },\n \"stream_mode\": [\n \"values\",\n \"messages-tuple\",\n \"custom\"\n ],\n \"stream_subgraphs\": true,\n \"stream_resumable\": true,\n \"assistant_id\": \"flowra-assistant\",\n \"on_disconnect\": \"continue\",\n \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"model\": \"openai/gpt-4o-mini\",\n \"reasoningEffort\": \"none\"\n}"
response = http.request(request)
puts response.read_bodyChat
Stream thread run
Run the agent/chat for this thread and stream the response via Server-Sent Events (SSE). Use for real-time chat UIs; events include message deltas and run status. A final event: usage reports credits for this turn and the thread total.
POST
/
api
/
v1
/
graphify
/
threads
/
{thread_id}
/
runs
/
stream
Stream thread run
curl --request POST \
--url https://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"command": {
"resume": {
"decision": "approve"
}
},
"stream_mode": [
"values",
"messages-tuple",
"custom"
],
"stream_subgraphs": true,
"stream_resumable": true,
"assistant_id": "flowra-assistant",
"on_disconnect": "continue",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"model": "openai/gpt-4o-mini",
"reasoningEffort": "none"
}
'import requests
url = "https://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream"
payload = {
"command": { "resume": { "decision": "approve" } },
"stream_mode": ["values", "messages-tuple", "custom"],
"stream_subgraphs": True,
"stream_resumable": True,
"assistant_id": "flowra-assistant",
"on_disconnect": "continue",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"model": "openai/gpt-4o-mini",
"reasoningEffort": "none"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
command: {resume: {decision: 'approve'}},
stream_mode: ['values', 'messages-tuple', 'custom'],
stream_subgraphs: true,
stream_resumable: true,
assistant_id: 'flowra-assistant',
on_disconnect: 'continue',
workflowId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
model: 'openai/gpt-4o-mini',
reasoningEffort: 'none'
})
};
fetch('https://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream', 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://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream",
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([
'command' => [
'resume' => [
'decision' => 'approve'
]
],
'stream_mode' => [
'values',
'messages-tuple',
'custom'
],
'stream_subgraphs' => true,
'stream_resumable' => true,
'assistant_id' => 'flowra-assistant',
'on_disconnect' => 'continue',
'workflowId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'model' => 'openai/gpt-4o-mini',
'reasoningEffort' => 'none'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream"
payload := strings.NewReader("{\n \"command\": {\n \"resume\": {\n \"decision\": \"approve\"\n }\n },\n \"stream_mode\": [\n \"values\",\n \"messages-tuple\",\n \"custom\"\n ],\n \"stream_subgraphs\": true,\n \"stream_resumable\": true,\n \"assistant_id\": \"flowra-assistant\",\n \"on_disconnect\": \"continue\",\n \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"model\": \"openai/gpt-4o-mini\",\n \"reasoningEffort\": \"none\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"command\": {\n \"resume\": {\n \"decision\": \"approve\"\n }\n },\n \"stream_mode\": [\n \"values\",\n \"messages-tuple\",\n \"custom\"\n ],\n \"stream_subgraphs\": true,\n \"stream_resumable\": true,\n \"assistant_id\": \"flowra-assistant\",\n \"on_disconnect\": \"continue\",\n \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"model\": \"openai/gpt-4o-mini\",\n \"reasoningEffort\": \"none\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/graphify/threads/{thread_id}/runs/stream")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"command\": {\n \"resume\": {\n \"decision\": \"approve\"\n }\n },\n \"stream_mode\": [\n \"values\",\n \"messages-tuple\",\n \"custom\"\n ],\n \"stream_subgraphs\": true,\n \"stream_resumable\": true,\n \"assistant_id\": \"flowra-assistant\",\n \"on_disconnect\": \"continue\",\n \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"model\": \"openai/gpt-4o-mini\",\n \"reasoningEffort\": \"none\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
x-api-keyx-api-key & x-username
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Headers
Optional host-issued identity token for the end user (HMAC/JWT). Used when the agent identity policy requires proof.
External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.
Path Parameters
Thread ID
Example:
"b737d8af-a9e0-4251-9714-3fdc1126e5fb"
Body
application/json
Show child attributes
Show child attributes
Run command forwarded as-is (e.g. { "resume": { "decisions": [...] } } for human-in-the-loop). Required when resuming without new messages.
Example:
{ "resume": { "decision": "approve" } }
Stream modes
Example:
["values", "messages-tuple", "custom"]
Stream subgraphs
Example:
true
Stream resumable
Example:
true
Assistant ID
Example:
"flowra-assistant"
Action on disconnect
Example:
"continue"
Workflow ID (agent workflow) to use for this conversation
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Optional model id override for this run (session-scoped). When set, wins over the agent workflow default model.
Example:
"openai/gpt-4o-mini"
Optional reasoning effort override for this run (session-scoped). none disables workflow default reasoning. low|medium|high when the model supports reasoning_effort.
Available options:
none, low, medium, high Example:
"none"
Response
Operation completed successfully
Was this page helpful?