2026-01-07 17:15:53 +01:00
---
2026-02-15 20:09:10 +05:30
summary: "Streaming + chunking behavior (block replies, Telegram preview streaming, limits)"
2026-01-07 17:15:53 +01:00
read_when:
2026-01-13 07:15:57 +00:00
- Explaining how streaming or chunking works on channels
- Changing block streaming or channel chunking behavior
2026-02-15 20:09:10 +05:30
- Debugging duplicate/early block replies or Telegram preview streaming
2026-01-31 16:04:03 -05:00
title: "Streaming and Chunking"
2026-01-07 17:15:53 +01:00
---
2026-01-31 21:13:13 +09:00
2026-01-07 17:15:53 +01:00
# Streaming + chunking
2026-01-30 03:15:10 +01:00
OpenClaw has two separate “streaming” layers:
2026-01-31 21:13:13 +09:00
2026-01-13 07:15:57 +00:00
- **Block streaming (channels):** emit completed **blocks** as the assistant writes. These are normal channel messages (not token deltas).
2026-02-15 20:09:10 +05:30
- **Token-ish streaming (Telegram only):** update a temporary **preview message** with partial text while generating.
2026-01-07 17:15:53 +01:00
2026-02-15 20:09:10 +05:30
There is **no true token-delta streaming** to channel messages today. Telegram preview streaming is the only partial-stream surface.
2026-01-07 17:15:53 +01:00
2026-01-13 07:15:57 +00:00
## Block streaming (channel messages)
2026-01-07 17:15:53 +01:00
Block streaming sends assistant output in coarse chunks as it becomes available.
```
Model output
└─ text_delta/events
├─ (blockStreamingBreak=text_end)
│ └─ chunker emits blocks as buffer grows
└─ (blockStreamingBreak=message_end)
└─ chunker flushes at message_end
2026-01-13 07:15:57 +00:00
└─ channel send (block replies)
2026-01-07 17:15:53 +01:00
```
2026-01-31 21:13:13 +09:00
2026-01-07 17:15:53 +01:00
Legend:
2026-01-31 21:13:13 +09:00
2026-01-07 17:15:53 +01:00
- `text_delta/events` : model stream events (may be sparse for non-streaming models).
- `chunker` : `EmbeddedBlockChunker` applying min/max bounds + break preference.
2026-01-13 07:15:57 +00:00
- `channel send` : actual outbound messages (block replies).
2026-01-07 17:15:53 +01:00
**Controls:**
2026-01-31 21:13:13 +09:00
2026-01-09 22:40:58 +01:00
- `agents.defaults.blockStreamingDefault` : `"on"` /`"off"` (default off).
2026-01-13 07:15:57 +00:00
- Channel overrides: `*.blockStreaming` (and per-account variants) to force `"on"` /`"off"` per channel.
2026-01-09 12:44:23 +00:00
- `agents.defaults.blockStreamingBreak` : `"text_end"` or `"message_end"` .
- `agents.defaults.blockStreamingChunk` : `{ minChars, maxChars, breakPreference? }` .
2026-01-09 18:19:55 +00:00
- `agents.defaults.blockStreamingCoalesce` : `{ minChars?, maxChars?, idleMs? }` (merge streamed blocks before send).
2026-01-13 07:15:57 +00:00
- Channel hard cap: `*.textChunkLimit` (e.g., `channels.whatsapp.textChunkLimit` ).
2026-01-25 13:24:00 +00:00
- Channel chunk mode: `*.chunkMode` (`length` default, `newline` splits on blank lines (paragraph boundaries) before length chunking).
2026-01-13 06:16:43 +00:00
- Discord soft cap: `channels.discord.maxLinesPerMessage` (default 17) splits tall replies to avoid UI clipping.
2026-01-07 17:15:53 +01:00
**Boundary semantics:**
2026-01-31 21:13:13 +09:00
2026-01-07 17:15:53 +01:00
- `text_end` : stream blocks as soon as chunker emits; flush on each `text_end` .
- `message_end` : wait until assistant message finishes, then flush buffered output.
`message_end` still uses the chunker if the buffered text exceeds `maxChars` , so it can emit multiple chunks at the end.
## Chunking algorithm (low/high bounds)
Block chunking is implemented by `EmbeddedBlockChunker` :
2026-01-31 21:13:13 +09:00
2026-01-07 17:15:53 +01:00
- **Low bound:** don’ t emit until buffer >= `minChars` (unless forced).
- **High bound:** prefer splits before `maxChars` ; if forced, split at `maxChars` .
- **Break preference:** `paragraph` → `newline` → `sentence` → `whitespace` → hard break.
- **Code fences:** never split inside fences; when forced at `maxChars` , close + reopen the fence to keep Markdown valid.
2026-01-13 07:15:57 +00:00
`maxChars` is clamped to the channel `textChunkLimit` , so you can’ t exceed per-channel caps.
2026-01-07 17:15:53 +01:00
2026-01-09 18:19:55 +00:00
## Coalescing (merge streamed blocks)
2026-01-30 03:15:10 +01:00
When block streaming is enabled, OpenClaw can **merge consecutive block chunks**
2026-01-09 18:19:55 +00:00
before sending them out. This reduces “single-line spam” while still providing
progressive output.
- Coalescing waits for **idle gaps** (`idleMs` ) before flushing.
- Buffers are capped by `maxChars` and will flush if they exceed it.
- `minChars` prevents tiny fragments from sending until enough text accumulates
(final flush always sends remaining text).
- Joiner is derived from `blockStreamingChunk.breakPreference`
(`paragraph` → `\n\n` , `newline` → `\n` , `sentence` → space).
2026-01-13 07:15:57 +00:00
- Channel overrides are available via `*.blockStreamingCoalesce` (including per-account configs).
2026-01-09 22:40:58 +01:00
- Default coalesce `minChars` is bumped to 1500 for Signal/Slack/Discord unless overridden.
2026-01-09 18:19:55 +00:00
2026-01-07 22:56:46 -05:00
## Human-like pacing between blocks
When block streaming is enabled, you can add a **randomized pause** between
block replies (after the first block). This makes multi-bubble responses feel
more natural.
- Config: `agents.defaults.humanDelay` (override per agent via `agents.list[].humanDelay` ).
- Modes: `off` (default), `natural` (800– 2500ms), `custom` (`minMs` /`maxMs` ).
- Applies only to **block replies** , not final replies or tool summaries.
2026-01-07 17:15:53 +01:00
## “Stream chunks or everything”
This maps to:
2026-01-31 21:13:13 +09:00
2026-01-13 07:15:57 +00:00
- **Stream chunks:** `blockStreamingDefault: "on"` + `blockStreamingBreak: "text_end"` (emit as you go). Non-Telegram channels also need `*.blockStreaming: true` .
2026-01-07 17:15:53 +01:00
- **Stream everything at end:** `blockStreamingBreak: "message_end"` (flush once, possibly multiple chunks if very long).
- **No block streaming:** `blockStreamingDefault: "off"` (only final reply).
2026-01-13 07:15:57 +00:00
**Channel note:** For non-Telegram channels, block streaming is **off unless**
2026-02-15 20:09:10 +05:30
`*.blockStreaming` is explicitly set to `true` . Telegram can stream a live preview
2026-01-13 06:16:43 +00:00
(`channels.telegram.streamMode` ) without block replies.
2026-01-09 22:40:58 +01:00
2026-01-13 07:58:47 +00:00
Config location reminder: the `blockStreaming*` defaults live under
`agents.defaults` , not the root config.
2026-02-15 20:09:10 +05:30
## Telegram preview streaming (token-ish)
2026-01-07 17:15:53 +01:00
2026-02-15 20:09:10 +05:30
Telegram is the only channel with live preview streaming:
2026-01-31 21:13:13 +09:00
2026-02-15 20:09:10 +05:30
- Uses Bot API `sendMessage` (first update) + `editMessageText` (subsequent updates).
2026-01-13 06:16:43 +00:00
- `channels.telegram.streamMode: "partial" | "block" | "off"` .
2026-02-15 20:09:10 +05:30
- `partial` : preview updates with latest stream text.
- `block` : preview updates in chunked blocks (same chunker rules).
- `off` : no preview streaming.
- Preview chunk config (only for `streamMode: "block"` ): `channels.telegram.draftChunk` (defaults: `minChars: 200` , `maxChars: 800` ).
- Preview streaming is separate from block streaming.
- When Telegram block streaming is explicitly enabled, preview streaming is skipped to avoid double-streaming.
- Text-only finals are applied by editing the preview message in place.
- Non-text/complex finals fall back to normal final message delivery.
- `/reasoning stream` writes reasoning into the live preview (Telegram only).
2026-01-07 17:15:53 +01:00
```
2026-02-15 20:09:10 +05:30
Telegram
└─ sendMessage (temporary preview message)
├─ streamMode=partial → edit latest text
└─ streamMode=block → chunker + edit updates
└─ final text-only reply → final edit on same message
└─ fallback: cleanup preview + normal final delivery (media/complex)
2026-01-07 17:15:53 +01:00
```
2026-01-31 21:13:13 +09:00
2026-01-07 17:15:53 +01:00
Legend:
2026-01-31 21:13:13 +09:00
2026-02-15 20:09:10 +05:30
- `preview message` : temporary Telegram message updated during generation.
- `final edit` : in-place edit on the same preview message (text-only).