Skip to content

docs: add missing SSE provider event and full status/error field shapes #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WilliamAGH merged 1 commit into from
Jul 17, 2026
Merged

docs: add missing SSE provider event and full status/error field shapes #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down