From 619c7fc20bf2d671173b095ef6cfa468a263fff0 Mon Sep 17 00:00:00 2001 From: Xubin Ren Date: Thu, 16 Apr 2026 17:43:53 +0000 Subject: [PATCH] docs(readme): reflect SSE streaming in OpenAI-compatible API section The Behavior bullet previously claimed `stream=true` is not supported. With this PR, /v1/chat/completions returns text/event-stream with OpenAI-compatible delta chunks when stream=true, so flip the bullet to describe the actual behavior instead of lying to readers. Made-with: Cursor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5cce6a33..88d2f8d5 100644 --- a/README.md +++ b/README.md @@ -1990,7 +1990,7 @@ By default, the API binds to `127.0.0.1:8900`. You can change this in `config.js - Session isolation: pass `"session_id"` in the request body to isolate conversations; omit for a shared default session (`api:default`) - Single-message input: each request must contain exactly one `user` message - Fixed model: omit `model`, or pass the same model shown by `/v1/models` -- No streaming: `stream=true` is not supported +- Streaming: set `stream=true` to receive Server-Sent Events (`text/event-stream`) with OpenAI-compatible delta chunks, terminated by `data: [DONE]`; omit or set `stream=false` for a single JSON response - **File uploads**: supports images, PDF, Word (.docx), Excel (.xlsx), PowerPoint (.pptx) via JSON base64 or `multipart/form-data` (max 10MB per file) - API requests run in the synthetic `api` channel, so the `message` tool does **not** automatically deliver to Telegram/Discord/etc. To proactively send to another chat, call `message` with an explicit `channel` and `chat_id` for an enabled channel.