Stream message
curl --request POST \
--url https://api.getcargo.io/v1/ai/messages/stream \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chatUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chatTrigger": {
"type": "connector",
"connectorUuid": "<string>",
"meta": {}
},
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parts": [
"<unknown>"
],
"agentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": true,
"config": {},
"kind": "tool",
"toolUuid": "<string>",
"templateSlug": "<string>",
"waitUntilFinished": true
}
],
"mcpClients": [
{
"kind": "custom",
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"disabledToolSlugs": [
"<string>"
]
}
],
"resources": [
{
"kind": "model",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"prompt": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": {
"groups": [
"<unknown>"
]
},
"selectedColumnSlugs": [
"<string>"
],
"limit": 123,
"isReadOnly": true
}
],
"capabilities": [
{
"slug": "sandbox",
"config": {}
}
],
"systemPrompt": "<string>",
"contextPrompt": "<string>",
"withReasoning": true,
"temperature": 123,
"maxSteps": 123,
"languageModelSlug": "<string>",
"integrationSlug": "<string>",
"connectorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"connectorUuid": "<string>",
"repository": "<string>",
"defaultBranch": "<string>",
"rootDirectory": "<string>",
"env": [
{
"key": "<string>",
"type": "public",
"value": "<string>"
}
]
}
}
'import requests
url = "https://api.getcargo.io/v1/ai/messages/stream"
payload = {
"chatUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chatTrigger": {
"type": "connector",
"connectorUuid": "<string>",
"meta": {}
},
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parts": ["<unknown>"],
"agentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": True,
"config": {},
"kind": "tool",
"toolUuid": "<string>",
"templateSlug": "<string>",
"waitUntilFinished": True
}
],
"mcpClients": [
{
"kind": "custom",
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"disabledToolSlugs": ["<string>"]
}
],
"resources": [
{
"kind": "model",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"prompt": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": { "groups": ["<unknown>"] },
"selectedColumnSlugs": ["<string>"],
"limit": 123,
"isReadOnly": True
}
],
"capabilities": [
{
"slug": "sandbox",
"config": {}
}
],
"systemPrompt": "<string>",
"contextPrompt": "<string>",
"withReasoning": True,
"temperature": 123,
"maxSteps": 123,
"languageModelSlug": "<string>",
"integrationSlug": "<string>",
"connectorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"connectorUuid": "<string>",
"repository": "<string>",
"defaultBranch": "<string>",
"rootDirectory": "<string>",
"env": [
{
"key": "<string>",
"type": "public",
"value": "<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({
chatUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
chatTrigger: {type: 'connector', connectorUuid: '<string>', meta: {}},
uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
parts: ['<unknown>'],
agentUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
actions: [
{
name: '<string>',
slug: '<string>',
description: '<string>',
isBulkAllowed: true,
config: {},
kind: 'tool',
toolUuid: '<string>',
templateSlug: '<string>',
waitUntilFinished: true
}
],
mcpClients: [
{
kind: 'custom',
name: '<string>',
url: '<string>',
authentication: {
issuedAt: '<string>',
accessToken: '<string>',
expiresIn: 123,
refreshToken: '<string>',
scope: '<string>',
tokenType: '<string>',
clientId: '<string>',
clientSecret: '<string>'
},
disabledToolSlugs: ['<string>']
}
],
resources: [
{
kind: 'model',
name: '<string>',
slug: '<string>',
description: '<string>',
prompt: '<string>',
integrationSlug: '<string>',
modelUuid: '<string>',
filter: {groups: ['<unknown>']},
selectedColumnSlugs: ['<string>'],
limit: 123,
isReadOnly: true
}
],
capabilities: [{slug: 'sandbox', config: {}}],
systemPrompt: '<string>',
contextPrompt: '<string>',
withReasoning: true,
temperature: 123,
maxSteps: 123,
languageModelSlug: '<string>',
integrationSlug: '<string>',
connectorUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
repository: {
connectorUuid: '<string>',
repository: '<string>',
defaultBranch: '<string>',
rootDirectory: '<string>',
env: [{key: '<string>', type: 'public', value: '<string>'}]
}
})
};
fetch('https://api.getcargo.io/v1/ai/messages/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://api.getcargo.io/v1/ai/messages/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([
'chatUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'chatTrigger' => [
'type' => 'connector',
'connectorUuid' => '<string>',
'meta' => [
]
],
'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'parts' => [
'<unknown>'
],
'agentUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'actions' => [
[
'name' => '<string>',
'slug' => '<string>',
'description' => '<string>',
'isBulkAllowed' => true,
'config' => [
],
'kind' => 'tool',
'toolUuid' => '<string>',
'templateSlug' => '<string>',
'waitUntilFinished' => true
]
],
'mcpClients' => [
[
'kind' => 'custom',
'name' => '<string>',
'url' => '<string>',
'authentication' => [
'issuedAt' => '<string>',
'accessToken' => '<string>',
'expiresIn' => 123,
'refreshToken' => '<string>',
'scope' => '<string>',
'tokenType' => '<string>',
'clientId' => '<string>',
'clientSecret' => '<string>'
],
'disabledToolSlugs' => [
'<string>'
]
]
],
'resources' => [
[
'kind' => 'model',
'name' => '<string>',
'slug' => '<string>',
'description' => '<string>',
'prompt' => '<string>',
'integrationSlug' => '<string>',
'modelUuid' => '<string>',
'filter' => [
'groups' => [
'<unknown>'
]
],
'selectedColumnSlugs' => [
'<string>'
],
'limit' => 123,
'isReadOnly' => true
]
],
'capabilities' => [
[
'slug' => 'sandbox',
'config' => [
]
]
],
'systemPrompt' => '<string>',
'contextPrompt' => '<string>',
'withReasoning' => true,
'temperature' => 123,
'maxSteps' => 123,
'languageModelSlug' => '<string>',
'integrationSlug' => '<string>',
'connectorUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'repository' => [
'connectorUuid' => '<string>',
'repository' => '<string>',
'defaultBranch' => '<string>',
'rootDirectory' => '<string>',
'env' => [
[
'key' => '<string>',
'type' => 'public',
'value' => '<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.getcargo.io/v1/ai/messages/stream"
payload := strings.NewReader("{\n \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chatTrigger\": {\n \"type\": \"connector\",\n \"connectorUuid\": \"<string>\",\n \"meta\": {}\n },\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parts\": [\n \"<unknown>\"\n ],\n \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"isBulkAllowed\": true,\n \"config\": {},\n \"kind\": \"tool\",\n \"toolUuid\": \"<string>\",\n \"templateSlug\": \"<string>\",\n \"waitUntilFinished\": true\n }\n ],\n \"mcpClients\": [\n {\n \"kind\": \"custom\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"authentication\": {\n \"issuedAt\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"expiresIn\": 123,\n \"refreshToken\": \"<string>\",\n \"scope\": \"<string>\",\n \"tokenType\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\"\n },\n \"disabledToolSlugs\": [\n \"<string>\"\n ]\n }\n ],\n \"resources\": [\n {\n \"kind\": \"model\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"modelUuid\": \"<string>\",\n \"filter\": {\n \"groups\": [\n \"<unknown>\"\n ]\n },\n \"selectedColumnSlugs\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"isReadOnly\": true\n }\n ],\n \"capabilities\": [\n {\n \"slug\": \"sandbox\",\n \"config\": {}\n }\n ],\n \"systemPrompt\": \"<string>\",\n \"contextPrompt\": \"<string>\",\n \"withReasoning\": true,\n \"temperature\": 123,\n \"maxSteps\": 123,\n \"languageModelSlug\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"repository\": {\n \"connectorUuid\": \"<string>\",\n \"repository\": \"<string>\",\n \"defaultBranch\": \"<string>\",\n \"rootDirectory\": \"<string>\",\n \"env\": [\n {\n \"key\": \"<string>\",\n \"type\": \"public\",\n \"value\": \"<string>\"\n }\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://api.getcargo.io/v1/ai/messages/stream")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chatTrigger\": {\n \"type\": \"connector\",\n \"connectorUuid\": \"<string>\",\n \"meta\": {}\n },\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parts\": [\n \"<unknown>\"\n ],\n \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"isBulkAllowed\": true,\n \"config\": {},\n \"kind\": \"tool\",\n \"toolUuid\": \"<string>\",\n \"templateSlug\": \"<string>\",\n \"waitUntilFinished\": true\n }\n ],\n \"mcpClients\": [\n {\n \"kind\": \"custom\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"authentication\": {\n \"issuedAt\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"expiresIn\": 123,\n \"refreshToken\": \"<string>\",\n \"scope\": \"<string>\",\n \"tokenType\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\"\n },\n \"disabledToolSlugs\": [\n \"<string>\"\n ]\n }\n ],\n \"resources\": [\n {\n \"kind\": \"model\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"modelUuid\": \"<string>\",\n \"filter\": {\n \"groups\": [\n \"<unknown>\"\n ]\n },\n \"selectedColumnSlugs\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"isReadOnly\": true\n }\n ],\n \"capabilities\": [\n {\n \"slug\": \"sandbox\",\n \"config\": {}\n }\n ],\n \"systemPrompt\": \"<string>\",\n \"contextPrompt\": \"<string>\",\n \"withReasoning\": true,\n \"temperature\": 123,\n \"maxSteps\": 123,\n \"languageModelSlug\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"repository\": {\n \"connectorUuid\": \"<string>\",\n \"repository\": \"<string>\",\n \"defaultBranch\": \"<string>\",\n \"rootDirectory\": \"<string>\",\n \"env\": [\n {\n \"key\": \"<string>\",\n \"type\": \"public\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/ai/messages/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 \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chatTrigger\": {\n \"type\": \"connector\",\n \"connectorUuid\": \"<string>\",\n \"meta\": {}\n },\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parts\": [\n \"<unknown>\"\n ],\n \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"isBulkAllowed\": true,\n \"config\": {},\n \"kind\": \"tool\",\n \"toolUuid\": \"<string>\",\n \"templateSlug\": \"<string>\",\n \"waitUntilFinished\": true\n }\n ],\n \"mcpClients\": [\n {\n \"kind\": \"custom\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"authentication\": {\n \"issuedAt\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"expiresIn\": 123,\n \"refreshToken\": \"<string>\",\n \"scope\": \"<string>\",\n \"tokenType\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\"\n },\n \"disabledToolSlugs\": [\n \"<string>\"\n ]\n }\n ],\n \"resources\": [\n {\n \"kind\": \"model\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"modelUuid\": \"<string>\",\n \"filter\": {\n \"groups\": [\n \"<unknown>\"\n ]\n },\n \"selectedColumnSlugs\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"isReadOnly\": true\n }\n ],\n \"capabilities\": [\n {\n \"slug\": \"sandbox\",\n \"config\": {}\n }\n ],\n \"systemPrompt\": \"<string>\",\n \"contextPrompt\": \"<string>\",\n \"withReasoning\": true,\n \"temperature\": 123,\n \"maxSteps\": 123,\n \"languageModelSlug\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"repository\": {\n \"connectorUuid\": \"<string>\",\n \"repository\": \"<string>\",\n \"defaultBranch\": \"<string>\",\n \"rootDirectory\": \"<string>\",\n \"env\": [\n {\n \"key\": \"<string>\",\n \"type\": \"public\",\n \"value\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"errorMessage": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}AI - Messages
Stream message
Stream a new message in a chat (POST /ai/messages/stream).
POST
/
ai
/
messages
/
stream
Stream message
curl --request POST \
--url https://api.getcargo.io/v1/ai/messages/stream \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chatUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chatTrigger": {
"type": "connector",
"connectorUuid": "<string>",
"meta": {}
},
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parts": [
"<unknown>"
],
"agentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": true,
"config": {},
"kind": "tool",
"toolUuid": "<string>",
"templateSlug": "<string>",
"waitUntilFinished": true
}
],
"mcpClients": [
{
"kind": "custom",
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"disabledToolSlugs": [
"<string>"
]
}
],
"resources": [
{
"kind": "model",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"prompt": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": {
"groups": [
"<unknown>"
]
},
"selectedColumnSlugs": [
"<string>"
],
"limit": 123,
"isReadOnly": true
}
],
"capabilities": [
{
"slug": "sandbox",
"config": {}
}
],
"systemPrompt": "<string>",
"contextPrompt": "<string>",
"withReasoning": true,
"temperature": 123,
"maxSteps": 123,
"languageModelSlug": "<string>",
"integrationSlug": "<string>",
"connectorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"connectorUuid": "<string>",
"repository": "<string>",
"defaultBranch": "<string>",
"rootDirectory": "<string>",
"env": [
{
"key": "<string>",
"type": "public",
"value": "<string>"
}
]
}
}
'import requests
url = "https://api.getcargo.io/v1/ai/messages/stream"
payload = {
"chatUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chatTrigger": {
"type": "connector",
"connectorUuid": "<string>",
"meta": {}
},
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parts": ["<unknown>"],
"agentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": True,
"config": {},
"kind": "tool",
"toolUuid": "<string>",
"templateSlug": "<string>",
"waitUntilFinished": True
}
],
"mcpClients": [
{
"kind": "custom",
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"disabledToolSlugs": ["<string>"]
}
],
"resources": [
{
"kind": "model",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"prompt": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": { "groups": ["<unknown>"] },
"selectedColumnSlugs": ["<string>"],
"limit": 123,
"isReadOnly": True
}
],
"capabilities": [
{
"slug": "sandbox",
"config": {}
}
],
"systemPrompt": "<string>",
"contextPrompt": "<string>",
"withReasoning": True,
"temperature": 123,
"maxSteps": 123,
"languageModelSlug": "<string>",
"integrationSlug": "<string>",
"connectorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"connectorUuid": "<string>",
"repository": "<string>",
"defaultBranch": "<string>",
"rootDirectory": "<string>",
"env": [
{
"key": "<string>",
"type": "public",
"value": "<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({
chatUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
chatTrigger: {type: 'connector', connectorUuid: '<string>', meta: {}},
uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
parts: ['<unknown>'],
agentUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
actions: [
{
name: '<string>',
slug: '<string>',
description: '<string>',
isBulkAllowed: true,
config: {},
kind: 'tool',
toolUuid: '<string>',
templateSlug: '<string>',
waitUntilFinished: true
}
],
mcpClients: [
{
kind: 'custom',
name: '<string>',
url: '<string>',
authentication: {
issuedAt: '<string>',
accessToken: '<string>',
expiresIn: 123,
refreshToken: '<string>',
scope: '<string>',
tokenType: '<string>',
clientId: '<string>',
clientSecret: '<string>'
},
disabledToolSlugs: ['<string>']
}
],
resources: [
{
kind: 'model',
name: '<string>',
slug: '<string>',
description: '<string>',
prompt: '<string>',
integrationSlug: '<string>',
modelUuid: '<string>',
filter: {groups: ['<unknown>']},
selectedColumnSlugs: ['<string>'],
limit: 123,
isReadOnly: true
}
],
capabilities: [{slug: 'sandbox', config: {}}],
systemPrompt: '<string>',
contextPrompt: '<string>',
withReasoning: true,
temperature: 123,
maxSteps: 123,
languageModelSlug: '<string>',
integrationSlug: '<string>',
connectorUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
repository: {
connectorUuid: '<string>',
repository: '<string>',
defaultBranch: '<string>',
rootDirectory: '<string>',
env: [{key: '<string>', type: 'public', value: '<string>'}]
}
})
};
fetch('https://api.getcargo.io/v1/ai/messages/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://api.getcargo.io/v1/ai/messages/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([
'chatUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'chatTrigger' => [
'type' => 'connector',
'connectorUuid' => '<string>',
'meta' => [
]
],
'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'parts' => [
'<unknown>'
],
'agentUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'actions' => [
[
'name' => '<string>',
'slug' => '<string>',
'description' => '<string>',
'isBulkAllowed' => true,
'config' => [
],
'kind' => 'tool',
'toolUuid' => '<string>',
'templateSlug' => '<string>',
'waitUntilFinished' => true
]
],
'mcpClients' => [
[
'kind' => 'custom',
'name' => '<string>',
'url' => '<string>',
'authentication' => [
'issuedAt' => '<string>',
'accessToken' => '<string>',
'expiresIn' => 123,
'refreshToken' => '<string>',
'scope' => '<string>',
'tokenType' => '<string>',
'clientId' => '<string>',
'clientSecret' => '<string>'
],
'disabledToolSlugs' => [
'<string>'
]
]
],
'resources' => [
[
'kind' => 'model',
'name' => '<string>',
'slug' => '<string>',
'description' => '<string>',
'prompt' => '<string>',
'integrationSlug' => '<string>',
'modelUuid' => '<string>',
'filter' => [
'groups' => [
'<unknown>'
]
],
'selectedColumnSlugs' => [
'<string>'
],
'limit' => 123,
'isReadOnly' => true
]
],
'capabilities' => [
[
'slug' => 'sandbox',
'config' => [
]
]
],
'systemPrompt' => '<string>',
'contextPrompt' => '<string>',
'withReasoning' => true,
'temperature' => 123,
'maxSteps' => 123,
'languageModelSlug' => '<string>',
'integrationSlug' => '<string>',
'connectorUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'repository' => [
'connectorUuid' => '<string>',
'repository' => '<string>',
'defaultBranch' => '<string>',
'rootDirectory' => '<string>',
'env' => [
[
'key' => '<string>',
'type' => 'public',
'value' => '<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.getcargo.io/v1/ai/messages/stream"
payload := strings.NewReader("{\n \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chatTrigger\": {\n \"type\": \"connector\",\n \"connectorUuid\": \"<string>\",\n \"meta\": {}\n },\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parts\": [\n \"<unknown>\"\n ],\n \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"isBulkAllowed\": true,\n \"config\": {},\n \"kind\": \"tool\",\n \"toolUuid\": \"<string>\",\n \"templateSlug\": \"<string>\",\n \"waitUntilFinished\": true\n }\n ],\n \"mcpClients\": [\n {\n \"kind\": \"custom\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"authentication\": {\n \"issuedAt\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"expiresIn\": 123,\n \"refreshToken\": \"<string>\",\n \"scope\": \"<string>\",\n \"tokenType\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\"\n },\n \"disabledToolSlugs\": [\n \"<string>\"\n ]\n }\n ],\n \"resources\": [\n {\n \"kind\": \"model\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"modelUuid\": \"<string>\",\n \"filter\": {\n \"groups\": [\n \"<unknown>\"\n ]\n },\n \"selectedColumnSlugs\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"isReadOnly\": true\n }\n ],\n \"capabilities\": [\n {\n \"slug\": \"sandbox\",\n \"config\": {}\n }\n ],\n \"systemPrompt\": \"<string>\",\n \"contextPrompt\": \"<string>\",\n \"withReasoning\": true,\n \"temperature\": 123,\n \"maxSteps\": 123,\n \"languageModelSlug\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"repository\": {\n \"connectorUuid\": \"<string>\",\n \"repository\": \"<string>\",\n \"defaultBranch\": \"<string>\",\n \"rootDirectory\": \"<string>\",\n \"env\": [\n {\n \"key\": \"<string>\",\n \"type\": \"public\",\n \"value\": \"<string>\"\n }\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://api.getcargo.io/v1/ai/messages/stream")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chatTrigger\": {\n \"type\": \"connector\",\n \"connectorUuid\": \"<string>\",\n \"meta\": {}\n },\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parts\": [\n \"<unknown>\"\n ],\n \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"isBulkAllowed\": true,\n \"config\": {},\n \"kind\": \"tool\",\n \"toolUuid\": \"<string>\",\n \"templateSlug\": \"<string>\",\n \"waitUntilFinished\": true\n }\n ],\n \"mcpClients\": [\n {\n \"kind\": \"custom\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"authentication\": {\n \"issuedAt\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"expiresIn\": 123,\n \"refreshToken\": \"<string>\",\n \"scope\": \"<string>\",\n \"tokenType\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\"\n },\n \"disabledToolSlugs\": [\n \"<string>\"\n ]\n }\n ],\n \"resources\": [\n {\n \"kind\": \"model\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"modelUuid\": \"<string>\",\n \"filter\": {\n \"groups\": [\n \"<unknown>\"\n ]\n },\n \"selectedColumnSlugs\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"isReadOnly\": true\n }\n ],\n \"capabilities\": [\n {\n \"slug\": \"sandbox\",\n \"config\": {}\n }\n ],\n \"systemPrompt\": \"<string>\",\n \"contextPrompt\": \"<string>\",\n \"withReasoning\": true,\n \"temperature\": 123,\n \"maxSteps\": 123,\n \"languageModelSlug\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"repository\": {\n \"connectorUuid\": \"<string>\",\n \"repository\": \"<string>\",\n \"defaultBranch\": \"<string>\",\n \"rootDirectory\": \"<string>\",\n \"env\": [\n {\n \"key\": \"<string>\",\n \"type\": \"public\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/ai/messages/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 \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chatTrigger\": {\n \"type\": \"connector\",\n \"connectorUuid\": \"<string>\",\n \"meta\": {}\n },\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parts\": [\n \"<unknown>\"\n ],\n \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"isBulkAllowed\": true,\n \"config\": {},\n \"kind\": \"tool\",\n \"toolUuid\": \"<string>\",\n \"templateSlug\": \"<string>\",\n \"waitUntilFinished\": true\n }\n ],\n \"mcpClients\": [\n {\n \"kind\": \"custom\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"authentication\": {\n \"issuedAt\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"expiresIn\": 123,\n \"refreshToken\": \"<string>\",\n \"scope\": \"<string>\",\n \"tokenType\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\"\n },\n \"disabledToolSlugs\": [\n \"<string>\"\n ]\n }\n ],\n \"resources\": [\n {\n \"kind\": \"model\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"modelUuid\": \"<string>\",\n \"filter\": {\n \"groups\": [\n \"<unknown>\"\n ]\n },\n \"selectedColumnSlugs\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"isReadOnly\": true\n }\n ],\n \"capabilities\": [\n {\n \"slug\": \"sandbox\",\n \"config\": {}\n }\n ],\n \"systemPrompt\": \"<string>\",\n \"contextPrompt\": \"<string>\",\n \"withReasoning\": true,\n \"temperature\": 123,\n \"maxSteps\": 123,\n \"languageModelSlug\": \"<string>\",\n \"integrationSlug\": \"<string>\",\n \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"repository\": {\n \"connectorUuid\": \"<string>\",\n \"repository\": \"<string>\",\n \"defaultBranch\": \"<string>\",\n \"rootDirectory\": \"<string>\",\n \"env\": [\n {\n \"key\": \"<string>\",\n \"type\": \"public\",\n \"value\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"errorMessage": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
bearerAuthoauth2
API token from cargo-ai login. Send as Authorization: Bearer <token>.
Headers
Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
Maximum string length:
255Example:
"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
application/json
Request body schema.
Chat identifier.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$Chat trigger configuration.
- Chat trigger
- Chat trigger
- Chat trigger
- Chat trigger
- Chat trigger
- Chat trigger
- Chat trigger
- Chat trigger
- Chat trigger
Show child attributes
Show child attributes
Message identifier.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$Message parts.
Agent identifier.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$Actions available for the message.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
MCP clients to use for the message.
- Option 1
- Option 2
Show child attributes
Show child attributes
Resources available for the message.
- Option 1
- Option 2
Show child attributes
Show child attributes
Capabilities available for the message.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
Show child attributes
Show child attributes
System prompt for the message.
Additional context for the message.
Whether to include reasoning.
Sampling temperature.
Maximum number of steps.
Language model identifier.
Integration identifier.
Connector identifier.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$Coding-agent runtime. Used when creating a new chat. Ignored on later turns.
Available options:
claudeCode, codex, openCode, deepAgents Git workspace for a coding harness. Used when creating a new chat. Unbound chats are allowed.
Show child attributes
Show child attributes
Response
Stream message
- Response body
- Response body
Response body schema.
Error message when the request fails.
Was this page helpful?