Skip to content

Scout Speak

Module · Stable

Speak text aloud through a paired Scout device (fire-and-forget).

Sends a ‘speak’ command to a Scout physical device. The device must be paired (POST /scout/mint) and have ‘speak’ in its capabilities. When device_id is omitted the step auto-selects the first available device. Returns enqueued=True and the command identifiers on success, or enqueued=False with an error string on failure (no device, no text).

Use when you want a flow to announce something aloud through a physical Scout device — e.g. an alert when a monitored condition triggers, a greeting at a reception kiosk, or a reminder spoken in the office. Pair with Branch on enqueued to handle the ‘no device available’ case gracefully.

Do not use to send audio to a user’s phone or browser — use Send Notification instead. If you need the flow to pause until the device has finished speaking, add a Wait step after this one with event=‘scout.spoken’. If no Scout device is paired, this step will return enqueued=False (not raise an error).

Configured per use: text, device_id, lang.

  • command_id
  • correlation_id
  • device_id
  • enqueued

Auto-generated from the skill registry (load_skills()). Do not edit by hand.