Skip to content

Interface: SuggestedPrompt

Defined in: types.ts:1762

A suggested prompt that appears as a button when an agent is opened in chat. These are static prompts defined in the pack manifest that provide quick access to common actions. An agent adds them with addSuggestedPrompt() on the agent builder.

Example

pack.addSuggestedPrompt({
  name: "ticketStatus",
  displayName: "Check ticket status",
  prompt: "Show me the status of all open support tickets"
});

Properties

displayName

displayName: string

Defined in: types.ts:1766

The display text shown to the user in the UI.


name

name: string

Defined in: types.ts:1764

A unique identifier for this suggested prompt. This acts as a stable ID for the prompt.


prompt

prompt: string

Defined in: types.ts:1768

The prompt text that gets executed when the user clicks this suggested prompt.