Streaming - ReyGrid Docs

streamChat() is an async generator that sends the chat request with stream: true and yields one ChatDeltaEvent per SSE frame.

for await (const frame of client.streamChat("{AgentId}", "What are your hours?", {
  userId: "user-42",
})) {
  process.stdout.write(frame.delta?.reply?.content ?? "");
}

Signature

streamChat(
  agentId: string,
  message: string,
  opts?: Omit<ChatRequest, "message" | "stream">,
): AsyncGenerator<ChatDeltaEvent>

opts accepts conversationId, userId, tools, and results.

`ChatDeltaEvent`

Field	Type	Description
`delta.reply.content`	`string?`	Text fragment
`delta.finish_reason`	`string?`	Set on the final frame
`delta.tool_calls`	`MessageToolCall[]?`	Tool-call deltas
`success`, `conversationId`, `messageId`	optional	Present on some frames
`usage`	`{ credits: number }?`	Present on the final frame

Collect the full text

let text = "";
for await (const frame of client.streamChat("{AgentId}", "Hello!")) {
  text += frame.delta?.reply?.content ?? "";
}

Callback style

consumeStream(stream, onEvent, onDone?, onError?) wraps a stream with callbacks and returns a function that cancels delivery.

import { consumeStream } from "reygrid";

const cancel = consumeStream(
  client.streamChat("{AgentId}", "Hello!"),
  (frame) => process.stdout.write(frame.delta?.reply?.content ?? ""),
  () => console.log("\ndone"),
  (err) => console.error(err),
);

Errors

HTTP errors before the stream starts throw the usual typed errors (for example ReyGridAuthError).
Failures during the stream, including malformed frames, are thrown as ReyGridStreamError.
Connection failures before the response throw ReyGridNetworkError.
timeoutMs covers the whole stream.

See Error handling.