> ## Documentation Index
> Fetch the complete documentation index at: https://agentheya.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# suggested_prompts block

> Clickable starter chips that seed the chat with a preset message when tapped.

# `suggested_prompts` block

A row of pill-shaped chips — "Reset my password", "Track my order", "Cancel subscription". Each chip carries both a short visible *label* and a full *message* that gets sent to the agent when the chip is clicked.

**Strong default**: almost every public agent should have one of these as the first thing the visitor sees. New visitors are far more likely to click a concrete suggestion than to write the perfect opening question themselves.

## When to use it

* The first screen of any public-facing agent — answers "what can I ask?".
* Replacing a wordy [markdown](/sections/page-layout/markdown) block that explains "here are some things you can try…".
* Pairing under a [hero](/sections/page-layout/hero) so the visitor has both an external CTA *and* a chat-starting option.

For structured field collection use [input\_capture](/sections/page-layout/input-capture); for outbound URL navigation use [links](/sections/page-layout/links).

## Shape

```json theme={null}
{
  "id": "starters-1",
  "type": "suggested_prompts",
  "position": "above_chat",
  "heading": "Try one of these",
  "prompts": [
    { "label": "Reset my password",      "message": "I forgot my password — how do I reset it?" },
    { "label": "Track an order",         "message": "I want to check the status of an order." },
    { "label": "Cancel my subscription", "message": "I want to cancel my subscription." }
  ],
  "behavior": "send_as_message"
}
```

| Field               | Required | Type                                  | Notes                                                                                      |
| ------------------- | -------- | ------------------------------------- | ------------------------------------------------------------------------------------------ |
| `id`                | yes      | string                                | Stable slug, unique.                                                                       |
| `type`              | yes      | `"suggested_prompts"`                 | Fixed.                                                                                     |
| `position`          | no       | enum                                  | Default `above_chat`.                                                                      |
| `heading`           | no       | string                                | Small heading above the chip row.                                                          |
| `prompts[]`         | **yes**  | array                                 | At least one item; schema rejects empty `prompts`.                                         |
| `prompts[].label`   | **yes**  | string                                | 2–5 word chip text.                                                                        |
| `prompts[].message` | **yes**  | string                                | The full message sent when the chip is clicked. Can include context, formatting, examples. |
| `prompts[].icon`    | no       | string                                | Reserved for future use.                                                                   |
| `behavior`          | no       | `send_as_message` / `append_to_input` | Default `send_as_message`.                                                                 |

## Click behaviour

After a chip is clicked **the rest of the chips in that block lock**. This protects an in-progress chat from being wiped if the visitor later clicks another chip (which would otherwise re-seed and remount the chat panel). The clicked chip stays visible with a check mark.

If the visitor wants to try a different starting point, they refresh the page.

## Tips

* Aim for 3–5 chips. Two looks unfinished; six+ defeats the "quick choice" effect.
* Chip *label* should be short and concrete; chip *message* can be longer and more specific (e.g. label `"Pricing"`, message `"Walk me through your pricing tiers and which one would suit a 5-person team."`).
* For agents with `stages` (multi-step purpose flows), think of the chips as the entry points to each major stage.
* Schema enforcement: AJV requires `prompts[].label` and `prompts[].message` to be non-empty. Patches with blank fields are rejected.