Trigger an Outbound Agent Run by Agent UUID
Start an outbound agent run using a workflow's stable Agent 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://talkr.intelstacks.com/telephony-configurations for hosted or http://localhost:3010/telephony-configurations for local).
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.
Your telephony provider must be configured before outbound calls will connect. See Telephony for setup instructions.
Path Parameters
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request model for triggering a call via API
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/public/agent/workflow/string" \ -H "X-API-Key: string" \ -H "Content-Type: application/json" \ -d '{ "phone_number": "string" }'{ "status": "string", "workflow_run_id": 0, "workflow_run_name": "string"}