bodhi-realtime-agent / UIPayload

Interface: UIPayload

Defined in: clients/client-protocol/dist/messages.d.ts:14

Structured UI payload for dual-channel delivery (voice + UI). Rides in ui.payload (server→client); ui.response.payload.requestId correlates.

Properties

data

data: Record<string, unknown>

Defined in: clients/client-protocol/dist/messages.d.ts:20

Type-specific data for rendering the UI element.

---

requestId?

optional requestId?: string

Defined in: clients/client-protocol/dist/messages.d.ts:18

Identifier for correlating UI responses back to the originating request.

---

type

type: "status" | "choice" | "confirmation" | "form" | "image"

Defined in: clients/client-protocol/dist/messages.d.ts:16

The kind of UI element to render on the client.