Skip to content
Elicitly

elicit_confirm

Ask the user an OK/Cancel confirmation — modeled on JavaScript’s confirm(), as a convenience wrapper over elicit_form.

When to use

Section titled “When to use”

One question, binary answer, decided by the person at the host right now. For multiple typed fields use elicit_form; for a decision that must survive the session or reach another reviewer, use the Pro approval tools — see Choosing a tool.

Input

Section titled “Input”
Parameter Type Required Description
message string yes The question shown to the user.
labels object no { ok?, cancel? }, each 1–40 characters. Defaults "OK" / "Cancel". Relabel or localize (e.g. Aceptar/Cancelar) — labels only rename the choices; their order and meaning stay fixed.
timeoutSeconds number no Default 300, clamped 60–3600 — how long to wait for the answer. The default 5 minutes gives a human time to notice and respond; raise it for a question you expect to sit unanswered for a while. 
{ "message": "Ship it?", "labels": { "ok": "OK", "cancel": "Cancel" }, "timeoutSeconds": 300 }

Output

Section titled “Output”
{ "confirmed": true, "action": "accept" }
  • Accept “OK” → { "confirmed": true, "action": "accept" }
  • Accept “Cancel” → { "confirmed": false, "action": "accept" }
  • Decline → { "confirmed": false, "action": "decline" }
  • Dismiss → { "confirmed": null, "action": "cancel", "message": "Ship it?" }
  • Error → { "confirmed": null, "action": "error", "message": "Ship it?" }

Unlike JavaScript’s confirm(), the result is three-state: an explicit “Cancel” choice is confirmed: false, while a dismissed dialog is confirmed: null.

Examples

Section titled “Examples”

A simple gate

Section titled “A simple gate”

Defaults are all most confirmations need:

{ "message": "Ship v2.1.0 to production?" }

The user sees an OK/Cancel dialog; on OK:

{ "confirmed": true, "action": "accept" }

A relabeled, destructive choice

Section titled “A relabeled, destructive choice”

For consequential actions, relabel the options so the button says what it does — and note the three-state subtlety in the result:

{
  "message": "Permanently delete 42 archived reports?",
  "labels": { "ok": "Delete permanently", "cancel": "Keep them" }
}

If the user picks “Keep them” and submits, that is an answered question, not a dismissal:

{ "confirmed": false, "action": "accept" }

— whereas closing the dialog without answering yields { "confirmed": null, "action": "cancel", … }. A skill deleting data should proceed only on "confirmed": true, treat false as a clear “no”, and treat null as “ask again later”.

Section titled “Related”