Built-in tools›Agent orchestration
Ask user
ask_user- Group
- Agent orchestration
- Turned on by
- Its own switch on the Tools page of Conversation settings.
- Approval
- Not reviewed: runs without asking, within the limits on this page.
- Profile key
tool.ask_user.description
Shows you a card of up to four multiple-choice questions and waits for your answers before the model goes on.
Every question has Other for an answer in your own words; a single-answer question whose options carry previews takes a note instead. Your answers become the call's result.
When it asks you
The card appears at every security level and never expires.
| You | What happens |
|---|---|
| Submit | Your answers go back to the model. You may skip questions. |
| Chat about this | The model gets the answers so far and asks what you want to talk through. |
| Send a message from the composer | The answers so far go back first, then your message. |
| Close the card (Esc) | The model is told you closed it, and the turn ends. |
On the card, ↑ and ↓ move, Enter selects, Tab switches questions and n adds a note to an option with a preview.
Parameters
| Parameter | Type | Details |
|---|---|---|
questions requiredQuestions | object[] | Questions to ask the user (1-4 questions) |
annotations | object | Optional per-question annotations from the user (e.g., notes on preview selections). Keyed by question text. |
answers | object | User answers collected by the permission component |
metadata | object | Optional metadata for tracking and analytics purposes. Not displayed to user. |