curl --request POST \
--url https://api.getcargo.io/v1/ai/messages/stream \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chatUuid": "<string>",
"chatTrigger": {
"type": "<string>",
"connectorUuid": "<string>",
"meta": {}
},
"uuid": "<string>",
"parts": [
"<unknown>"
],
"agentUuid": "<string>",
"tools": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": true,
"config": {},
"kind": "<string>",
"toolUuid": "<string>",
"templateSlug": "<string>"
}
],
"mcpClients": [
{
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>"
},
"disabledToolSlugs": [
"<string>"
]
}
],
"resources": [
{
"kind": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": {
"conjonction": "or",
"groups": [
"<unknown>"
]
},
"selectedColumnSlugs": [
"<string>"
],
"limit": 123,
"prompt": "<string>"
}
],
"capabilities": [
{
"slug": "<string>"
}
],
"systemPrompt": "<string>",
"contextPrompt": "<string>",
"withReasoning": true,
"temperature": 123,
"maxSteps": 123,
"languageModelSlug": "<string>",
"integrationSlug": "<string>",
"connectorUuid": "<string>"
}
'{
"errorMessage": "<string>"
}Stream a new message in a chat
curl --request POST \
--url https://api.getcargo.io/v1/ai/messages/stream \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chatUuid": "<string>",
"chatTrigger": {
"type": "<string>",
"connectorUuid": "<string>",
"meta": {}
},
"uuid": "<string>",
"parts": [
"<unknown>"
],
"agentUuid": "<string>",
"tools": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": true,
"config": {},
"kind": "<string>",
"toolUuid": "<string>",
"templateSlug": "<string>"
}
],
"mcpClients": [
{
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>"
},
"disabledToolSlugs": [
"<string>"
]
}
],
"resources": [
{
"kind": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": {
"conjonction": "or",
"groups": [
"<unknown>"
]
},
"selectedColumnSlugs": [
"<string>"
],
"limit": 123,
"prompt": "<string>"
}
],
"capabilities": [
{
"slug": "<string>"
}
],
"systemPrompt": "<string>",
"contextPrompt": "<string>",
"withReasoning": true,
"temperature": 123,
"maxSteps": 123,
"languageModelSlug": "<string>",
"integrationSlug": "<string>",
"connectorUuid": "<string>"
}
'{
"errorMessage": "<string>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Request body schema.
Chat identifier.
Chat trigger configuration.
Show child attributes
Message identifier.
Message parts.
Agent identifier.
Tools available for the message.
Show child attributes
MCP clients to use for the message.
Show child attributes
Resources available for the message.
Show child attributes
Capabilities available for the message.
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.
Successful response
Response body schema.
Error message when the request fails.
Was this page helpful?