Stream an AI agent
curl --request POST \
--url https://app.myhero.so/ai-agent/stream \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chatMessages": [
{
"text": "<string>",
"metadata": {}
}
],
"context": {
"documentId": "<string>",
"projectId": "<string>",
"workspaceId": "<string>",
"organizationId": "<string>",
"mentions": [
"<unknown>"
]
},
"options": {
"provider": "<string>",
"model": "<string>"
},
"attachments": [
{
"filename": "<string>",
"mimeType": "<string>",
"base64": "<string>",
"size": 1
}
],
"sessionId": "<string>",
"documentRefs": [
{
"documentId": "<string>",
"addedAt": 123
}
]
}
'import requests
url = "https://app.myhero.so/ai-agent/stream"
payload = {
"chatMessages": [
{
"text": "<string>",
"metadata": {}
}
],
"context": {
"documentId": "<string>",
"projectId": "<string>",
"workspaceId": "<string>",
"organizationId": "<string>",
"mentions": ["<unknown>"]
},
"options": {
"provider": "<string>",
"model": "<string>"
},
"attachments": [
{
"filename": "<string>",
"mimeType": "<string>",
"base64": "<string>",
"size": 1
}
],
"sessionId": "<string>",
"documentRefs": [
{
"documentId": "<string>",
"addedAt": 123
}
]
}
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({
chatMessages: [{text: '<string>', metadata: {}}],
context: {
documentId: '<string>',
projectId: '<string>',
workspaceId: '<string>',
organizationId: '<string>',
mentions: ['<unknown>']
},
options: {provider: '<string>', model: '<string>'},
attachments: [{filename: '<string>', mimeType: '<string>', base64: '<string>', size: 1}],
sessionId: '<string>',
documentRefs: [{documentId: '<string>', addedAt: 123}]
})
};
fetch('https://app.myhero.so/ai-agent/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://app.myhero.so/ai-agent/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([
'chatMessages' => [
[
'text' => '<string>',
'metadata' => [
]
]
],
'context' => [
'documentId' => '<string>',
'projectId' => '<string>',
'workspaceId' => '<string>',
'organizationId' => '<string>',
'mentions' => [
'<unknown>'
]
],
'options' => [
'provider' => '<string>',
'model' => '<string>'
],
'attachments' => [
[
'filename' => '<string>',
'mimeType' => '<string>',
'base64' => '<string>',
'size' => 1
]
],
'sessionId' => '<string>',
'documentRefs' => [
[
'documentId' => '<string>',
'addedAt' => 123
]
]
]),
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://app.myhero.so/ai-agent/stream"
payload := strings.NewReader("{\n \"chatMessages\": [\n {\n \"text\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"context\": {\n \"documentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"mentions\": [\n \"<unknown>\"\n ]\n },\n \"options\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\"\n },\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"base64\": \"<string>\",\n \"size\": 1\n }\n ],\n \"sessionId\": \"<string>\",\n \"documentRefs\": [\n {\n \"documentId\": \"<string>\",\n \"addedAt\": 123\n }\n ]\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://app.myhero.so/ai-agent/stream")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"chatMessages\": [\n {\n \"text\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"context\": {\n \"documentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"mentions\": [\n \"<unknown>\"\n ]\n },\n \"options\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\"\n },\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"base64\": \"<string>\",\n \"size\": 1\n }\n ],\n \"sessionId\": \"<string>\",\n \"documentRefs\": [\n {\n \"documentId\": \"<string>\",\n \"addedAt\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.myhero.so/ai-agent/stream")
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 \"chatMessages\": [\n {\n \"text\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"context\": {\n \"documentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"mentions\": [\n \"<unknown>\"\n ]\n },\n \"options\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\"\n },\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"base64\": \"<string>\",\n \"size\": 1\n }\n ],\n \"sessionId\": \"<string>\",\n \"documentRefs\": [\n {\n \"documentId\": \"<string>\",\n \"addedAt\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}Ai
Stream an AI agent
Runs the general AI agent and streams its response as Server-Sent Events over text/event-stream.
Each event carries a type (delta, tool_call, tool_result, done, or error) and a per-type payload.
The done event includes sessionId, hasUndo, and a changes summary of entities modified during the run.
POST
/
ai-agent
/
stream
Stream an AI agent
curl --request POST \
--url https://app.myhero.so/ai-agent/stream \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chatMessages": [
{
"text": "<string>",
"metadata": {}
}
],
"context": {
"documentId": "<string>",
"projectId": "<string>",
"workspaceId": "<string>",
"organizationId": "<string>",
"mentions": [
"<unknown>"
]
},
"options": {
"provider": "<string>",
"model": "<string>"
},
"attachments": [
{
"filename": "<string>",
"mimeType": "<string>",
"base64": "<string>",
"size": 1
}
],
"sessionId": "<string>",
"documentRefs": [
{
"documentId": "<string>",
"addedAt": 123
}
]
}
'import requests
url = "https://app.myhero.so/ai-agent/stream"
payload = {
"chatMessages": [
{
"text": "<string>",
"metadata": {}
}
],
"context": {
"documentId": "<string>",
"projectId": "<string>",
"workspaceId": "<string>",
"organizationId": "<string>",
"mentions": ["<unknown>"]
},
"options": {
"provider": "<string>",
"model": "<string>"
},
"attachments": [
{
"filename": "<string>",
"mimeType": "<string>",
"base64": "<string>",
"size": 1
}
],
"sessionId": "<string>",
"documentRefs": [
{
"documentId": "<string>",
"addedAt": 123
}
]
}
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({
chatMessages: [{text: '<string>', metadata: {}}],
context: {
documentId: '<string>',
projectId: '<string>',
workspaceId: '<string>',
organizationId: '<string>',
mentions: ['<unknown>']
},
options: {provider: '<string>', model: '<string>'},
attachments: [{filename: '<string>', mimeType: '<string>', base64: '<string>', size: 1}],
sessionId: '<string>',
documentRefs: [{documentId: '<string>', addedAt: 123}]
})
};
fetch('https://app.myhero.so/ai-agent/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://app.myhero.so/ai-agent/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([
'chatMessages' => [
[
'text' => '<string>',
'metadata' => [
]
]
],
'context' => [
'documentId' => '<string>',
'projectId' => '<string>',
'workspaceId' => '<string>',
'organizationId' => '<string>',
'mentions' => [
'<unknown>'
]
],
'options' => [
'provider' => '<string>',
'model' => '<string>'
],
'attachments' => [
[
'filename' => '<string>',
'mimeType' => '<string>',
'base64' => '<string>',
'size' => 1
]
],
'sessionId' => '<string>',
'documentRefs' => [
[
'documentId' => '<string>',
'addedAt' => 123
]
]
]),
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://app.myhero.so/ai-agent/stream"
payload := strings.NewReader("{\n \"chatMessages\": [\n {\n \"text\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"context\": {\n \"documentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"mentions\": [\n \"<unknown>\"\n ]\n },\n \"options\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\"\n },\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"base64\": \"<string>\",\n \"size\": 1\n }\n ],\n \"sessionId\": \"<string>\",\n \"documentRefs\": [\n {\n \"documentId\": \"<string>\",\n \"addedAt\": 123\n }\n ]\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://app.myhero.so/ai-agent/stream")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"chatMessages\": [\n {\n \"text\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"context\": {\n \"documentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"mentions\": [\n \"<unknown>\"\n ]\n },\n \"options\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\"\n },\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"base64\": \"<string>\",\n \"size\": 1\n }\n ],\n \"sessionId\": \"<string>\",\n \"documentRefs\": [\n {\n \"documentId\": \"<string>\",\n \"addedAt\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.myhero.so/ai-agent/stream")
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 \"chatMessages\": [\n {\n \"text\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"context\": {\n \"documentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"mentions\": [\n \"<unknown>\"\n ]\n },\n \"options\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\"\n },\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"base64\": \"<string>\",\n \"size\": 1\n }\n ],\n \"sessionId\": \"<string>\",\n \"documentRefs\": [\n {\n \"documentId\": \"<string>\",\n \"addedAt\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}Authorizations
HERO personal access token
Body
application/json
⌘I