Skip to main content

Interface: UiPromptPresented

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:67

A UI prompt that has been shown to the member and is awaiting an answer.

Serialized as the ToolMessage content of the tool call that raised it.

Properties​

connect?​

optional connect: UiPromptConnect | null

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:81

Connect-card payload; inline_connect only

description?​

optional description: string | null

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:77

Agent-only context for render_ui; never shown to the member

instructions​

instructions: string

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:83

LLM-facing guidance: shown, not answered yet — see presented_instructions

kind​

kind: UiPromptPresentedKind

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:71

multi?​

optional multi: boolean

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:79

present_choice_list allows multiple selections

openuiMarkup?​

optional openuiMarkup: string | null

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:75

OpenUI Lang markup for render_ui / present_choice_list

promptId​

promptId: string

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:70

The tool_call_id of the tool call that raised this prompt

status?​

optional status: "presented"

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:68

userPrompt?​

optional userPrompt: string | null

Defined in: packages/sdk/src/types/generated/ui_prompt.ts:73

Heading shown above the UI