Chat with Agent
curl --request POST \
--url https://api.boostgpt.co/v1/bot/chat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"bot_id": "<string>",
"message": "<string>",
"provider_key": "<string>",
"provider_host": "<string>",
"model": "<string>",
"source_ids": [
"<string>"
],
"tags": [
"<string>"
],
"top": 5,
"instruction": "<string>",
"max_reply_tokens": 123,
"stream": false,
"chat_id": "<string>",
"reasoning_mode": "auto",
"chat_mode": "ask",
"memory": true,
"attachments": [
{}
],
"pasted": [
"<string>"
],
"workspace_uuid": "<string>",
"purpose": "service"
}
'import requests
url = "https://api.boostgpt.co/v1/bot/chat"
payload = {
"project_id": "<string>",
"bot_id": "<string>",
"message": "<string>",
"provider_key": "<string>",
"provider_host": "<string>",
"model": "<string>",
"source_ids": ["<string>"],
"tags": ["<string>"],
"top": 5,
"instruction": "<string>",
"max_reply_tokens": 123,
"stream": False,
"chat_id": "<string>",
"reasoning_mode": "auto",
"chat_mode": "ask",
"memory": True,
"attachments": [{}],
"pasted": ["<string>"],
"workspace_uuid": "<string>",
"purpose": "service"
}
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({
project_id: '<string>',
bot_id: '<string>',
message: '<string>',
provider_key: '<string>',
provider_host: '<string>',
model: '<string>',
source_ids: ['<string>'],
tags: ['<string>'],
top: 5,
instruction: '<string>',
max_reply_tokens: 123,
stream: false,
chat_id: '<string>',
reasoning_mode: 'auto',
chat_mode: 'ask',
memory: true,
attachments: [{}],
pasted: ['<string>'],
workspace_uuid: '<string>',
purpose: 'service'
})
};
fetch('https://api.boostgpt.co/v1/bot/chat', 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.boostgpt.co/v1/bot/chat",
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([
'project_id' => '<string>',
'bot_id' => '<string>',
'message' => '<string>',
'provider_key' => '<string>',
'provider_host' => '<string>',
'model' => '<string>',
'source_ids' => [
'<string>'
],
'tags' => [
'<string>'
],
'top' => 5,
'instruction' => '<string>',
'max_reply_tokens' => 123,
'stream' => false,
'chat_id' => '<string>',
'reasoning_mode' => 'auto',
'chat_mode' => 'ask',
'memory' => true,
'attachments' => [
[
]
],
'pasted' => [
'<string>'
],
'workspace_uuid' => '<string>',
'purpose' => 'service'
]),
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.boostgpt.co/v1/bot/chat"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"message\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"provider_host\": \"<string>\",\n \"model\": \"<string>\",\n \"source_ids\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"top\": 5,\n \"instruction\": \"<string>\",\n \"max_reply_tokens\": 123,\n \"stream\": false,\n \"chat_id\": \"<string>\",\n \"reasoning_mode\": \"auto\",\n \"chat_mode\": \"ask\",\n \"memory\": true,\n \"attachments\": [\n {}\n ],\n \"pasted\": [\n \"<string>\"\n ],\n \"workspace_uuid\": \"<string>\",\n \"purpose\": \"service\"\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.boostgpt.co/v1/bot/chat")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"message\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"provider_host\": \"<string>\",\n \"model\": \"<string>\",\n \"source_ids\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"top\": 5,\n \"instruction\": \"<string>\",\n \"max_reply_tokens\": 123,\n \"stream\": false,\n \"chat_id\": \"<string>\",\n \"reasoning_mode\": \"auto\",\n \"chat_mode\": \"ask\",\n \"memory\": true,\n \"attachments\": [\n {}\n ],\n \"pasted\": [\n \"<string>\"\n ],\n \"workspace_uuid\": \"<string>\",\n \"purpose\": \"service\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.boostgpt.co/v1/bot/chat")
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 \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"message\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"provider_host\": \"<string>\",\n \"model\": \"<string>\",\n \"source_ids\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"top\": 5,\n \"instruction\": \"<string>\",\n \"max_reply_tokens\": 123,\n \"stream\": false,\n \"chat_id\": \"<string>\",\n \"reasoning_mode\": \"auto\",\n \"chat_mode\": \"ask\",\n \"memory\": true,\n \"attachments\": [\n {}\n ],\n \"pasted\": [\n \"<string>\"\n ],\n \"workspace_uuid\": \"<string>\",\n \"purpose\": \"service\"\n}"
response = http.request(request)
puts response.read_body{
"chat": {
"reply": "<string>",
"user": {
"uuid": "<string>",
"chat_id": "<string>",
"content": "<string>",
"role": "user",
"model": "<string>",
"complexity": "<string>",
"reasoning_type": "<string>",
"estimated_time_ms": "<string>",
"estimated_cost": "<string>",
"confidence": "<string>",
"channel": "<string>",
"credit_used": "<string>",
"confidence_score": "<string>",
"tokens": 123,
"upvotes": 123,
"downvotes": 123,
"reasoning": {},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"updated_at": "2023-11-07T05:31:56Z",
"isToolExecuting": true
},
"agent": {
"uuid": "<string>",
"chat_id": "<string>",
"content": "<string>",
"role": "user",
"model": "<string>",
"complexity": "<string>",
"reasoning_type": "<string>",
"estimated_time_ms": "<string>",
"estimated_cost": "<string>",
"confidence": "<string>",
"channel": "<string>",
"credit_used": "<string>",
"confidence_score": "<string>",
"tokens": 123,
"upvotes": 123,
"downvotes": 123,
"reasoning": {},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"updated_at": "2023-11-07T05:31:56Z",
"isToolExecuting": true
},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"meta": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123,
"reasoning_type": "<string>",
"conversation_count": 123,
"prompt_tokens_details": {
"cached_tokens": 123,
"audio_tokens": 123
},
"completion_tokens_details": {
"reasoning_tokens": 123,
"audio_tokens": 123,
"accepted_prediction_tokens": 123,
"rejected_prediction_tokens": 123
}
},
"config_used": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"analytics_id": 123,
"actual_time_ms": 123,
"type": "<string>",
"tool": {
"name": "<string>",
"description": "<string>",
"server_label": "<string>",
"parameters": {},
"reasoning": "<string>"
},
"requiresApproval": true,
"executionId": "<string>",
"originalQuery": "<string>",
"context": "<string>",
"executedTools": [
{}
],
"isComplete": true,
"availableTools": 123,
"stepInfo": "<string>",
"hasMoreSteps": true,
"finalAnswer": "<string>",
"reasoningSteps": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"totalSteps": 123,
"reasoning": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"reasoningCycles": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"totalCycles": 123,
"converged": true
}
}Chat
Chat with Agent
Send a message to an agent and receive a response
POST
/
v1
/
bot
/
chat
Chat with Agent
curl --request POST \
--url https://api.boostgpt.co/v1/bot/chat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"bot_id": "<string>",
"message": "<string>",
"provider_key": "<string>",
"provider_host": "<string>",
"model": "<string>",
"source_ids": [
"<string>"
],
"tags": [
"<string>"
],
"top": 5,
"instruction": "<string>",
"max_reply_tokens": 123,
"stream": false,
"chat_id": "<string>",
"reasoning_mode": "auto",
"chat_mode": "ask",
"memory": true,
"attachments": [
{}
],
"pasted": [
"<string>"
],
"workspace_uuid": "<string>",
"purpose": "service"
}
'import requests
url = "https://api.boostgpt.co/v1/bot/chat"
payload = {
"project_id": "<string>",
"bot_id": "<string>",
"message": "<string>",
"provider_key": "<string>",
"provider_host": "<string>",
"model": "<string>",
"source_ids": ["<string>"],
"tags": ["<string>"],
"top": 5,
"instruction": "<string>",
"max_reply_tokens": 123,
"stream": False,
"chat_id": "<string>",
"reasoning_mode": "auto",
"chat_mode": "ask",
"memory": True,
"attachments": [{}],
"pasted": ["<string>"],
"workspace_uuid": "<string>",
"purpose": "service"
}
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({
project_id: '<string>',
bot_id: '<string>',
message: '<string>',
provider_key: '<string>',
provider_host: '<string>',
model: '<string>',
source_ids: ['<string>'],
tags: ['<string>'],
top: 5,
instruction: '<string>',
max_reply_tokens: 123,
stream: false,
chat_id: '<string>',
reasoning_mode: 'auto',
chat_mode: 'ask',
memory: true,
attachments: [{}],
pasted: ['<string>'],
workspace_uuid: '<string>',
purpose: 'service'
})
};
fetch('https://api.boostgpt.co/v1/bot/chat', 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.boostgpt.co/v1/bot/chat",
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([
'project_id' => '<string>',
'bot_id' => '<string>',
'message' => '<string>',
'provider_key' => '<string>',
'provider_host' => '<string>',
'model' => '<string>',
'source_ids' => [
'<string>'
],
'tags' => [
'<string>'
],
'top' => 5,
'instruction' => '<string>',
'max_reply_tokens' => 123,
'stream' => false,
'chat_id' => '<string>',
'reasoning_mode' => 'auto',
'chat_mode' => 'ask',
'memory' => true,
'attachments' => [
[
]
],
'pasted' => [
'<string>'
],
'workspace_uuid' => '<string>',
'purpose' => 'service'
]),
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.boostgpt.co/v1/bot/chat"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"message\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"provider_host\": \"<string>\",\n \"model\": \"<string>\",\n \"source_ids\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"top\": 5,\n \"instruction\": \"<string>\",\n \"max_reply_tokens\": 123,\n \"stream\": false,\n \"chat_id\": \"<string>\",\n \"reasoning_mode\": \"auto\",\n \"chat_mode\": \"ask\",\n \"memory\": true,\n \"attachments\": [\n {}\n ],\n \"pasted\": [\n \"<string>\"\n ],\n \"workspace_uuid\": \"<string>\",\n \"purpose\": \"service\"\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.boostgpt.co/v1/bot/chat")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"message\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"provider_host\": \"<string>\",\n \"model\": \"<string>\",\n \"source_ids\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"top\": 5,\n \"instruction\": \"<string>\",\n \"max_reply_tokens\": 123,\n \"stream\": false,\n \"chat_id\": \"<string>\",\n \"reasoning_mode\": \"auto\",\n \"chat_mode\": \"ask\",\n \"memory\": true,\n \"attachments\": [\n {}\n ],\n \"pasted\": [\n \"<string>\"\n ],\n \"workspace_uuid\": \"<string>\",\n \"purpose\": \"service\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.boostgpt.co/v1/bot/chat")
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 \"project_id\": \"<string>\",\n \"bot_id\": \"<string>\",\n \"message\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"provider_host\": \"<string>\",\n \"model\": \"<string>\",\n \"source_ids\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"top\": 5,\n \"instruction\": \"<string>\",\n \"max_reply_tokens\": 123,\n \"stream\": false,\n \"chat_id\": \"<string>\",\n \"reasoning_mode\": \"auto\",\n \"chat_mode\": \"ask\",\n \"memory\": true,\n \"attachments\": [\n {}\n ],\n \"pasted\": [\n \"<string>\"\n ],\n \"workspace_uuid\": \"<string>\",\n \"purpose\": \"service\"\n}"
response = http.request(request)
puts response.read_body{
"chat": {
"reply": "<string>",
"user": {
"uuid": "<string>",
"chat_id": "<string>",
"content": "<string>",
"role": "user",
"model": "<string>",
"complexity": "<string>",
"reasoning_type": "<string>",
"estimated_time_ms": "<string>",
"estimated_cost": "<string>",
"confidence": "<string>",
"channel": "<string>",
"credit_used": "<string>",
"confidence_score": "<string>",
"tokens": 123,
"upvotes": 123,
"downvotes": 123,
"reasoning": {},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"updated_at": "2023-11-07T05:31:56Z",
"isToolExecuting": true
},
"agent": {
"uuid": "<string>",
"chat_id": "<string>",
"content": "<string>",
"role": "user",
"model": "<string>",
"complexity": "<string>",
"reasoning_type": "<string>",
"estimated_time_ms": "<string>",
"estimated_cost": "<string>",
"confidence": "<string>",
"channel": "<string>",
"credit_used": "<string>",
"confidence_score": "<string>",
"tokens": 123,
"upvotes": 123,
"downvotes": 123,
"reasoning": {},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"updated_at": "2023-11-07T05:31:56Z",
"isToolExecuting": true
},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"meta": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123,
"reasoning_type": "<string>",
"conversation_count": 123,
"prompt_tokens_details": {
"cached_tokens": 123,
"audio_tokens": 123
},
"completion_tokens_details": {
"reasoning_tokens": 123,
"audio_tokens": 123,
"accepted_prediction_tokens": 123,
"rejected_prediction_tokens": 123
}
},
"config_used": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"analytics_id": 123,
"actual_time_ms": 123,
"type": "<string>",
"tool": {
"name": "<string>",
"description": "<string>",
"server_label": "<string>",
"parameters": {},
"reasoning": "<string>"
},
"requiresApproval": true,
"executionId": "<string>",
"originalQuery": "<string>",
"context": "<string>",
"executedTools": [
{}
],
"isComplete": true,
"availableTools": 123,
"stepInfo": "<string>",
"hasMoreSteps": true,
"finalAnswer": "<string>",
"reasoningSteps": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"totalSteps": 123,
"reasoning": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"reasoningCycles": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"totalCycles": 123,
"converged": true
}
}Authorizations
Enter your API key
Body
application/json
Project ID
Agent ID
The user's message
Optional API key for the AI provider
Optional host URL for the AI provider
Override the default model for this request
Specific memory sources to use
Filter memory by tags
Number of memory results to include
Override system instructions for this request
Maximum tokens in the response
Enable streaming response
Chat conversation ID (creates new if not provided)
Reasoning mode for the agent response. 'auto' selects the best approach automatically, 'standard' for quick single-pass answers (1x credit), 'agent' for autonomous multi-step reasoning with tool use (up to 10x credit)
Available options:
auto, standard, agent Chat mode. 'ask' for normal chat, 'edit' for agent-powered code editing, 'plan' for conversational plan-then-execute workflow
Available options:
ask, edit, plan Search the agent's knowledge before answering. Omit to use the agent's own setting; an explicit value overrides it, and it gates the search_memory tool for agent turns.
Files to attach to this message
Long pasted text, kept out of the message body
Target a specific workspace for this turn
Set to service when your own backend is calling on behalf of many end users, rather than one person chatting. Allows workspace_uuid to pin the turn to a workspace and lets chat_mode survive the request. Never grants the Site builder persona or access to other people's conversations. Granted only when the API key belongs to a member of the project; requesting it otherwise is ignored and the call proceeds unchanged.
Available options:
service Response
200 - application/json
Chat response received successfully
Response structure varies based on reasoning_mode. Contains 'chat' object with mode-specific fields.
Chat response data with mode-specific structure
Show child attributes
Show child attributes
Was this page helpful?
⌘I