read

Ask the user a question and present a small set of options as clickable buttons — a multiple-choice menu. Use this whene

Ask the user a question and present a small set of options as clickable buttons — a multiple-choice menu. Use this whenever a decision is genuinely the user's to make and the answer is one of a few clear choices (confirming an approach, mapping values, yes/no with context, picking between options). Prefer it over a free-text question when you can enumerate the choices. Give 2–6 concise options, each a short label with an optional one-line description. Set multi_select=true when the user may pick several. The user's selection arrives as their next message — after calling this, STOP and wait for it; do not assume an answer.

post/api/v1/tools/ask_user_question

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/ask_user_question
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: read)

Request body

questionstring required

The question to ask.

multi_selectboolean

Allow selecting more than one option. Default false.

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.