Generate report and stream response

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>"
}

{
  "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>"
}

POST

projects

{project_id}

reports

generations

Generate report and stream response

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>"
}

{
  "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

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

project_id

string

required

Body

application/json

message

string

required

User message to send to the Summation agent.

Minimum string length: 1

display_content

string | null

Optional alternate rendering of the message for display; the agent still receives message.

file_ids

string[]

Project file ids to attach to the message as context.

mentioned_file_ids

string[]

Project file ids referenced inline in the message.

model

string | null

Chat model id to use for this turn, from GET /v1/chat-models. Per-request model selection is honored where enabled for the tenant; otherwise the default model applies. The reply metadata reports the model that ran.

Minimum string length: 1

effort

enum<string> | null

Reasoning effort for this turn (low, medium, high, xhigh, max). Honored under the same tenant setting as model selection; otherwise the default effort applies.

Available options:

low,

medium,

high,

xhigh,

max

title

string | null

Optional conversation title; derived from the message when omitted.

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) or data.summary (short status line)
tool.started — agent invoked a tool; data.id, data.name
tool.input — tool input arguments; data.id, data.name, data.input
tool.completed — tool finished; data.id
message.delta — incremental assistant text; data.text (append in order)
done — terminal event; data.messageId, data.content (final assistant message), data.status (complete / error / cancelled)

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.

⌘I

Get started

Features

API & Integrations

API Reference

Generate report and stream response

Authorizations

Path Parameters

Body

Response