POST
Initiate Call
Use this endpoint when you want to execute a workflow 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 call 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://app.peachdeskai.com/telephony-configurations for hosted or http://localhost:3010/telephony-configurations for local). Pass from_number to pin which of your numbers the recipient sees as the caller ID. Give it in E.164 form (+14155551212). It must be an active outbound number on the resolved telephony configuration; a number your organization does not own is rejected with 400 from_number_not_found. When omitted, Peachdesk rotates automatically across the outbound numbers on that configuration so one number is not used for every call. See Caller ID selection. Pass metadata to attach an opaque object that Peachdesk echoes back verbatim as call.metadata on the call webhooks, for correlating the call with your own records. Unlike dynamic_variables, metadata is not rendered into the agentтАЩs prompt. See Dynamic variables and metadata. The destination is the required to_number field. Give it in E.164 form (+14155550123).
This route expects an API Trigger node UUID (trigger_path). Do not pass a workflow UUID here. If you want to execute by workflow UUID, use Trigger an outbound call by workflow UUID instead.
Your telephony provider must be configured before outbound calls will connect. See Telephony for setup instructions.

Authorizations

X-API-Key
string
header
required

Organization API key (bibha_...). Takes precedence over the session credential, and is refused outright on user-session-only and super-admin routes.

Path Parameters

uuid
string
required

Body

application/json

Request model for triggering a call via API

to_number
string
required
initial_context
Initial Context ┬╖ object | null
telephony_configuration_id
integer | null
dynamic_variables
Dynamic Variables ┬╖ object | null
from_number
string | null
metadata
Metadata ┬╖ object | null

Response

Successful Response

Response model for successful call initiation

status
string
required
workflow_run_id
integer
required
workflow_run_name
string
required
call_id
string
required