Skip to main content

Trigger an Outbound Agent Run by Agent UUID

Start an outbound agent run using a workflow's stable Agent UUID
1 min read
post/api/v1/public/agent/workflow/{workflow_uuid}
Request example
Response
post/api/v1/public/agent/workflow/{workflow_uuid}

Use this endpoint when you want to start an agent run directly by its stable Agent UUID instead of through an API Trigger node.

The workflow_uuid is the workflow's Agent UUID. It is different from an API Trigger node's trigger_path.

To find and copy the Agent UUID in the UI, see Agent UUID.

Use workflow_run_id from the response to later retrieve run details, recordings, and transcripts.

Pass initial_context to inject runtime data as template variables into the agent's prompt. See Using initial context.

Pass telephony_configuration_id to route the call through a specific telephony configuration instead of your organization's default. The id is shown on each row in Telephony configurations (https://voice.menaceui.com/telephony-configurations for hosted or http://localhost:3010/telephony-configurations for local).

Pass from_phone_number_id to use a specific active caller ID in the resolved telephony configuration. The number ID must belong to that configuration. Retrieve number IDs with List phone numbers.

Note

This route expects a workflow UUID. Do not pass an API Trigger node UUID here. If you want to execute via an API Trigger node, use Trigger an outbound agent run instead.

Note

Your telephony provider must be configured before outbound calls will connect. See Telephony for setup instructions.

Path parameters

workflow_uuidstringrequired#

Headers

X-API-Keystringrequired#

Body

application/json
phone_numberstringrequired#
initial_contextobject · null#
Show child attributes
telephony_configuration_idinteger · null#
Show child attributes
from_phone_number_idinteger · null#
Show child attributes

Responses

application/json
Successful Response
statusstringrequired#
workflow_run_idintegerrequired#
workflow_run_namestringrequired#