---
title: "Create conversation with streaming response"
method: POST
path: "/conversations/stream"
tags: ["Conversations"]
---

# Create conversation with streaming response

`POST /conversations/stream`

Start a new conversation and stream the AI response over Server-Sent
Events (SSE). Behaves like `POST /conversations` but emits tokens,
tool activity, and status updates incrementally instead of returning
a single JSON response at the end.

**Lifecycle**

1. The server validates `query`, persists an in-progress
   conversation, then opens the SSE stream with HTTP `200`.
2. A `CUSTOM` event named `conversation_created` is emitted
   immediately with the new `conversationId` so the client can link
   the stream (sidebar, parallel tabs, deep links) without an extra
   request.
3. AI-backend events stream through (token chunks, tool calls,
   status, etc.).
4. On success a single root `RUN_FINISHED` event is emitted carrying
   the full persisted conversation in `result`.
5. On failure a root `RUN_ERROR` event is emitted and the
   conversation is marked FAILED before the stream closes.

**Event vocabulary**

AG-UI is the sole wire protocol. See `ConversationStreamSSEEvent`
for the full event enum and payload guidance.

Clients should ignore unknown event names rather than treating them
as errors.

**Agent mode**

When `chatMode` is `agent`,
the optional `tools` list restricts which tools the agent may
invoke for this turn. Outside agent modes the `tools` field is
ignored.

## Request body

- ConversationStreamRequest — Request body for `POST /conversations/stream`. The public stream requires an explicit universal execution mode.
  - `query` string, required — The user's question or prompt to start the conversation. Supports natural language queries of any complexity.
  - `recordIds` string[] — Limit the AI's knowledge scope to specific records/documents. When provided, only these records will be searched for context.
  - `filters` Filters — App connector instance ids and knowledge-base / record-group ids that narrow retrieval for a turn. For **org assistant** chat streams, send explicit `apps` / `kb` lists. For **agent** chat streams, send explicit id lists, or **omit** `filters` (and `tools`) to let the service use the agent’s stored knowledge and tool configuration. Sending `{ "apps": [], "kb": [] }` on an agent stream means **no** knowledge sources for that turn (it is not “full org default”).
    - `apps` string[] — Connector instance ids to scope retrieval for this turn. Each element must be a valid UUID (connector app id, KB app id, record-group id, etc.). Gateway validation matches Zod `appOrKbIdSchema`.
    - `kb` string[] — Knowledge-base app ids to scope retrieval for this turn. Each element must be a valid UUID.
  - `appliedFilters` AppliedFilters — Rich filter state selected by the user, used for display and persistence only. This mirrors the active selection shown in the UI and is distinct from the machine-readable `filters` field used for retrieval scoping.
    - `apps` AppliedFilterNode[] — Applied app/connector filter nodes
      - `id` string — Unique identifier of the filter node
      - `name` string — Display name of the filter node
      - `nodeType` string — Type of the node (e.g. app, recordGroup, folder, record)
      - `connector` string — Connector identifier associated with this node
    - `kb` AppliedFilterNode[] — Applied knowledge-base filter nodes
      - `id` string — Unique identifier of the filter node
      - `name` string — Display name of the filter node
      - `nodeType` string — Type of the node (e.g. app, recordGroup, folder, record)
      - `connector` string — Connector identifier associated with this node
  - `attachments` ChatAttachmentRef[] — Uploaded chat attachments to associate with this conversation turn (see `POST /conversations/attachments/upload`).
    - `recordId` string, required — Attachment record id returned from the upload endpoint.
    - `recordName` string — Original display name of the file when known.
    - `mimeType` string — MIME type of the uploaded file.
    - `extension` string — File extension (e.g. `pdf`).
    - `virtualRecordId` string — Optional synthetic record id used by the graph layer.
  - `modelKey` string — Identifier for the AI model configuration to use. Available models depend on organization settings.
  - `modelName` string — Display name of the AI model
  - `modelFriendlyName` string — Friendly display name of the selected model
  - `chatMode` 'agent' | 'internal_search' | 'web_search', required — Optional execution mode for non-stream consumers of this shared request schema. `agent` uses the universal agent loop, while `internal_search` and `web_search` use their corresponding assistant search paths.
  - `timezone` string — IANA timezone identifier from the client (top-level field). Used to provide time-aware context to the AI.
  - `currentTime` string, date-time — ISO 8601 / RFC 3339 datetime from the client (top-level field; UTC `Z` or numeric offset).
  - `tools` string[] — Optional list of tool identifiers (fully-qualified action names such as "jira.create_issue") that the AI agent is permitted to invoke for this request. When omitted the agent may use any configured tool. Applicable only when `chatMode` is `agent`.
  - `protocol` 'agui' — AG-UI is the only supported wire protocol. When present must be `"agui"`. Omitting the field is equivalent — the server always uses the AG-UI vocabulary (`RUN_STARTED`, `TEXT_MESSAGE_CONTENT`, etc.). Kept in the schema for backward compatibility with callers that already send it.
  - `agentCapabilities` AgentCapabilities — Per-request agent capability toggles. Only meaningful when `chatMode` selects an agent mode; ignored otherwise. Each field falls back to its own `default` below when omitted — a missing flag is not uniformly `true`. Omitting the whole object applies every default.
    - `internalSearch` boolean — Whether the agent may search internal knowledge bases for this turn.
    - `webSearch` boolean — Whether the agent may perform web search for this turn.
    - `deepSearch` boolean — Whether the agent may use deeper, higher-latency retrieval for this turn.

## Response `200`

SSE stream established. The body is a sequence of
`text/event-stream` frames using the event vocabulary described
above.

## Other responses

- `400` — Invalid request — `query` is missing, empty, or exceeds the 100000-character limit, or another field fails validation (for example a malformed `recordIds` or `currentTime`).
- `401` — Unauthorized — valid bearer token required.
- `403` — Forbidden — the caller's token does not include the `conversation:chat` OAuth scope.
- `500` — Internal error before the SSE stream is established (for example, the initial conversation row could not be persisted). Once the stream is open, terminal failures are surfaced as a `RUN_ERROR` SSE event instead of an HTTP status change.

---

[API](https://skmtc.net/pipeshub-ai/apis/pipeshub-api.md) · [All operations](https://skmtc.net/pipeshub-ai/apis/pipeshub-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipeshub-ai/pipeshub-api/revisions/64bfe76b130e/schema)