---
title: "Stream message"
method: POST
path: "/ai/messages/stream"
tags: ["AI - Messages"]
---

# Stream message

`POST /ai/messages/stream`

Stream a new message in a chat

## Request body

- object — Request body schema.
  - `chatUuid` string, uuid, required — Chat identifier.
  - `chatTrigger` union, required — Chat trigger configuration.
    - object
      - `type` 'connector', required
      - `connectorUuid` string, required
      - `meta` object, required
    - object
      - `type` 'draft', required
    - object
      - `type` 'web_extension', required
      - `url` string, uri, nullable, required
    - object
      - `type` 'app', required
    - object
      - `type` 'workflow', required
      - `uuid` string, required
      - `nodeUuid` string, required
      - `runUuid` string, nullable, required
  - `uuid` string, uuid, required — Message identifier.
  - `parts` unknown[], required — Message parts.
    - unknown
  - `agentUuid` string, uuid — Agent identifier.
  - `actions` union[] — Actions available for the message.
    - union
      - object
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `isBulkAllowed` boolean, required
        - `config` object, required
        - `kind` 'tool', required
        - `toolUuid` string, nullable, required
        - `templateSlug` string, nullable, required
        - `waitUntilFinished` boolean, required
      - object
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `isBulkAllowed` boolean, required
        - `config` object, required
        - `kind` 'agent', required
        - `agentUuid` string, nullable, required
        - `templateSlug` string, nullable, required
        - `waitUntilFinished` boolean, required
      - object
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `isBulkAllowed` boolean, required
        - `config` object, required
        - `kind` 'connector', required
        - `integrationSlug` string, required
        - `connectorUuid` string, nullable, required
        - `actionSlug` string, required
  - `mcpClients` union[] — MCP clients to use for the message.
    - union
      - object
        - `kind` 'custom', required
        - `name` string, required
        - `url` string, required
        - `authentication` object, nullable, required
          - `issuedAt` string, required
          - `accessToken` string, required
          - `expiresIn` number
          - `refreshToken` string
          - `scope` string
          - `tokenType` string
          - `clientId` string
          - `clientSecret` string
        - `disabledToolSlugs` string[], required
      - object
        - `kind` 'connector', required
        - `name` string, required
        - `connectorUuid` string, required
        - `integrationSlug` string, required
        - `disabledToolSlugs` string[], required
  - `resources` union[] — Resources available for the message.
    - union
      - object
        - `kind` 'model', required
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `integrationSlug` string, nullable, required
        - `modelUuid` string, nullable, required
        - `filter` object, nullable, required
          - `conjonction` 'or' | 'and', required
          - `groups` unknown[], required
            - unknown
        - `selectedColumnSlugs` string[], nullable, required
        - `limit` number, nullable, required
        - `prompt` string, nullable, required
        - `isReadOnly` boolean, required
      - object
        - `kind` 'file', required
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `items` union[], required
          - union
            - object
              - …
            - object
              - …
        - `prompt` string, nullable, required
  - `capabilities` union[] — Capabilities available for the message.
    - union
      - object
        - `slug` 'sandbox', required
        - `config` object, required
          - `scope` 'chat' | 'agent'
      - object
        - `slug` 'context', required
        - `config` object, required
          - `isReadOnly` boolean
      - object
        - `slug` 'app', required
        - `config` object, required
          - `appUuid` string
          - `canPromote` boolean
      - object
        - `slug` 'document', required
        - `config` object, required
      - object
        - `slug` 'webSearch', required
        - `config` object, required
      - object
        - `slug` 'fileSearch', required
        - `config` object, required
      - object
        - `slug` 'documentationSearch', required
        - `config` object, required
      - object
        - `slug` 'codeInterpreter', required
        - `config` object, required
      - object
        - `slug` 'memory', required
        - `config` object, required
      - object
        - `slug` 'suggestedActions', required
        - `config` object, required
  - `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.

## Response `200`

Successful response

- union — Response body schema.
  - object
    - `errorMessage` string, required — Error message when the request fails.
  - object
    - `reason` 'lastMessageNotFinished', required — Failure reason.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/getcargo/apis/cargo-api.md) · [All operations](https://skmtc.net/getcargo/apis/cargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getcargo/cargo-api/versions/1d5a19e01d83/schema)