curl --request POST \
--url https://api.example.com/v1/projects/{project_id}/reports/generations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"display_content": "<string>",
"file_ids": [
"<string>"
],
"mentioned_file_ids": [
"<string>"
],
"model": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.example.com/v1/projects/{project_id}/reports/generations"
payload = {
"message": "<string>",
"display_content": "<string>",
"file_ids": ["<string>"],
"mentioned_file_ids": ["<string>"],
"model": "<string>",
"title": "<string>"
}
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({
message: '<string>',
display_content: '<string>',
file_ids: ['<string>'],
mentioned_file_ids: ['<string>'],
model: '<string>',
title: '<string>'
})
};
fetch('https://api.example.com/v1/projects/{project_id}/reports/generations', 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.example.com/v1/projects/{project_id}/reports/generations",
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([
'message' => '<string>',
'display_content' => '<string>',
'file_ids' => [
'<string>'
],
'mentioned_file_ids' => [
'<string>'
],
'model' => '<string>',
'title' => '<string>'
]),
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.example.com/v1/projects/{project_id}/reports/generations"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"display_content\": \"<string>\",\n \"file_ids\": [\n \"<string>\"\n ],\n \"mentioned_file_ids\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"title\": \"<string>\"\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.example.com/v1/projects/{project_id}/reports/generations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"display_content\": \"<string>\",\n \"file_ids\": [\n \"<string>\"\n ],\n \"mentioned_file_ids\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/projects/{project_id}/reports/generations")
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 \"message\": \"<string>\",\n \"display_content\": \"<string>\",\n \"file_ids\": [\n \"<string>\"\n ],\n \"mentioned_file_ids\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}Generate report and stream response
Generate a report from a prompt using the Summation analyst agent, streaming progress as Server-Sent Events until the report completes. Generation can take minutes; the stream carries status and content events, then a terminal event with the result.
curl --request POST \
--url https://api.example.com/v1/projects/{project_id}/reports/generations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"display_content": "<string>",
"file_ids": [
"<string>"
],
"mentioned_file_ids": [
"<string>"
],
"model": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.example.com/v1/projects/{project_id}/reports/generations"
payload = {
"message": "<string>",
"display_content": "<string>",
"file_ids": ["<string>"],
"mentioned_file_ids": ["<string>"],
"model": "<string>",
"title": "<string>"
}
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({
message: '<string>',
display_content: '<string>',
file_ids: ['<string>'],
mentioned_file_ids: ['<string>'],
model: '<string>',
title: '<string>'
})
};
fetch('https://api.example.com/v1/projects/{project_id}/reports/generations', 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.example.com/v1/projects/{project_id}/reports/generations",
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([
'message' => '<string>',
'display_content' => '<string>',
'file_ids' => [
'<string>'
],
'mentioned_file_ids' => [
'<string>'
],
'model' => '<string>',
'title' => '<string>'
]),
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.example.com/v1/projects/{project_id}/reports/generations"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"display_content\": \"<string>\",\n \"file_ids\": [\n \"<string>\"\n ],\n \"mentioned_file_ids\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"title\": \"<string>\"\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.example.com/v1/projects/{project_id}/reports/generations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"display_content\": \"<string>\",\n \"file_ids\": [\n \"<string>\"\n ],\n \"mentioned_file_ids\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/projects/{project_id}/reports/generations")
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 \"message\": \"<string>\",\n \"display_content\": \"<string>\",\n \"file_ids\": [\n \"<string>\"\n ],\n \"mentioned_file_ids\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}Authorizations
Body
Response
Server-Sent Events stream of agent activity.
Each event is a UTF-8 line prefixed with event:, id:, or data: per the SSE spec. The data: payload is a JSON object with the shape {"type": <event_type>, "sequence": <int>, "data": <object>}.
Event types emitted by the agent:
status— high-level progress;data.message(queued/running text) ordata.summary(short status line). When the conversation was busy and the message was queued (request fieldon_busy: "queue"), the first event isstatuswithdata.message: "queued"(or"held"if a Stop has already paused the queue),data.queuedMessageId,data.position,data.behindMessageId,data.held, anddata.revision; the reply then streams once the queued turn dispatches. A held queue does not run until it is resumed.queue.updated— the waiting message's queue state changed;data.position,data.held,data.revision,data.queuedMessageId.held: truemeans a Stop paused the queue: the message will not run until the queue is resumed (POST .../queue/resume).revisiononly moves forward; ignore any snapshot older than one you hold.tool.started— agent invoked a tool;data.id,data.nametool.input— tool input arguments;data.id,data.name,data.inputtool.completed— tool finished;data.idmessage.delta— incremental assistant text;data.text(append in order)done— terminal event;data.messageId,data.content(final assistant message),data.status(complete/error/cancelled)error— terminal error;data.code,data.message. A queued message may end withcode: "queue_wait_timeout"after 30 minutes of waiting — the message is still queued and can be observed again via the queue endpoints.
Resumability: when the connection drops before done, the same stream can be resumed via GET /v1/projects/{project_id}/conversations/{chat_id}/messages/{message_id}/events. Before a queued message has bound an assistant message id, reconnect by re-sending with the same idempotency_key, or poll GET /v1/projects/{project_id}/conversations/{chat_id}/queue/{queued_message_id}.