Skip to main content
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": "<string>",
    "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": "<string>",
      "toolUuid": "<string>",
      "templateSlug": "<string>"
    }
  ],
  "mcpClients": [
    {
      "kind": "<string>",
      "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": {
        "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": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "errorMessage": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

​
chatUuid
string<uuid>
required

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})$
​
chatTrigger
Chat trigger · object
required

Chat trigger configuration.

​
uuid
string<uuid>
required

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})$
​
parts
any[]
required

Message parts.

​
agentUuid
string<uuid>

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
Actions · object[]

Actions available for the message.

​
mcpClients
MCP clients · object[]

MCP clients to use for the message.

​
resources
Resources · object[]

Resources available for the message.

​
capabilities
Capabilities · object[]

Capabilities available for the message.

​
systemPrompt
string

System prompt for the message.

​
contextPrompt
string

Additional context for the message.

​
withReasoning
boolean

Whether to include reasoning.

​
temperature
number

Sampling temperature.

​
maxSteps
number

Maximum number of steps.

​
languageModelSlug
string

Language model identifier.

​
integrationSlug
string

Integration identifier.

​
connectorUuid
string<uuid>

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})$

Response

Successful response

Response body schema.

​
errorMessage
string
required

Error message when the request fails.