Trigger an Outbound Agent Run by API Trigger Node
Start an outbound agent run using an API Trigger node UUID
Use this endpoint when you want to start an agent run through an API Trigger node.
The uuid comes from the API Trigger node in your agent. Add the node to your workflow and copy its auto-generated trigger_path.
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 an API Trigger node UUID (trigger_path). Do not pass a workflow UUID here. If you want to execute by Agent UUID, use Trigger an outbound agent run by Agent UUID 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/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"}