Streaming - ReyGrid Docs

Set "stream": true in the chat request to receive the reply as a Server-Sent Events (SSE) stream of delta events instead of a single JSON body.

The stream uses data-only messages (data: field). No event: field is sent.
Each data: line carries a JSON object.

curl -N -X POST https://reygrid.com/api/v1/agents/{AgentId}/chat \
  -H "Authorization: Bearer $REYGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "What are your hours?", "stream": true}'

Frame shape

The OpenAPI document only states that frames are delta events. The official SDKs parse frames of this shape:

data: {"success":true,"delta":{"reply":{"content":"Hello"}}}

data: {"delta":{"reply":{"content":" there"}}}

data: {"delta":{"reply":{"content":""},"finish_reason":"stop"},"usage":{"credits":1}}

Field	Notes
`delta.reply.content`	Text fragment to append
`delta.finish_reason`	Set on the terminal frame
`delta.tool_calls`	Tool calls delivered as deltas
`usage.credits`	Present on the terminal frame
`conversationId`, `messageId`	May be present

The frame schema comes from the SDK implementations and tests, not from the OpenAPI specification. An empty data: message is treated by the SDKs as an end-of-stream marker.

Read a stream

for frame in client.stream_chat("{AgentId}", "What are your hours?"):
    if frame.delta and frame.delta.reply and frame.delta.reply.content:
        print(frame.delta.reply.content, end="")

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

If you call the API directly, parse each data: line as JSON and append delta.reply.content. Errors that happen before streaming starts (such as 400 or 401) are returned as normal JSON error responses.