StartScreenPrompt

type StartScreenPrompt = {
  icon?: ChatKitIcon;
  label: string;
  prompt: string | UserMessageContent[];
};

Properties

icon?

optional icon: ChatKitIcon;

Optional icon displayed with the prompt.

See

ChatKitIcon

---

label

label: string;

Human-readable label shown for the prompt.

---

prompt

prompt:
  | string
  | UserMessageContent[];

Preset message content submitted as a user message when selected. Provide a simple string for most prompts; use structured UserMessageContent segments only when you need advanced rich input (e.g. prefilled tags).

See

UserMessageContent