POST
/
api
/
v1
/
public
/
agent
/
{uuid}
Initiate Call
curl --request POST \
  --url https://app.peachdesk.bibha.ai/api/v1/public/agent/{uuid} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "phone_number": "<string>",
  "initial_context": {},
  "telephony_configuration_id": 123
}
'
{
  "status": "<string>",
  "workflow_run_id": 123,
  "workflow_run_name": "<string>"
}
The simplest way to initiate a call programmatically. 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.peachdesk.bibha.ai/telephony-configurations for hosted or http://localhost:3010/telephony-configurations for local).
Your telephony provider must be configured before outbound calls will connect. See Telephony for setup instructions.

Headers

​
X-API-Key
string
required

Path Parameters

​
uuid
string
required

Body

application/json

Request model for triggering a call via API

​
phone_number
string
required
​
initial_context
Initial Context · object
​
telephony_configuration_id
integer | null

Response

Successful Response

Response model for successful call initiation

​
status
string
required
​
workflow_run_id
integer
required
​
workflow_run_name
string
required