From d4562974e137d819104f8bdd9a64c3b0f6b236a3 Mon Sep 17 00:00:00 2001
From: "detail-app[bot]" <180357370+detail-app[bot]@users.noreply.github.com>
Date: Tue, 14 Jul 2026 16:21:59 +0000
Subject: [PATCH] docs: add missing SSE provider event and full status/error
 field shapes

---
 docs/api.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/api.md b/docs/api.md
index 1d55e98a..e1386f9c 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -14,11 +14,11 @@ Request body:
 
 SSE event types (see `SseConstants`):
 
-- `status` → `{"message":"...","details":"..."}`
-- `provider` → `{"provider":"GitHub Models"}` (the configured provider selected for this request)
+- `status` → `{"message":"...","details":"...","provider":"...","code":"...","retryable":bool,"stage":"...","attempt":int,"maxAttempts":int}` (only `message` is required; all others nullable)
+- `provider` → `{"provider":"..."}` (emitted before fallback status events)
 - `text` → `{"text":"..."}`
 - `citation` → JSON array of citations
-- `error` → `{"message":"...","details":"..."}`
+- `error` → `{"message":"...","details":"...","provider":"...","code":"...","retryable":bool,"stage":"...","attempt":int,"maxAttempts":int}` (only `message` is required; all others nullable)
 
 Example: