Skip to content

Interface: SuggestedPrompt

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

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

Properties

displayName

displayName: string

The display text shown to the user in the UI.


name

name: string

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


prompt

prompt: string

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