Overview
Initiate outbound calls and trigger agents via the API
| Method | Endpoint | Quick Link |
|---|---|---|
POST | /public/agent/{uuid} | Trigger an outbound call by API Trigger node |
POST | /public/agent/workflow/{workflow_uuid} | Trigger an outbound call by workflow UUID |
GET | /workflow/{workflow_id}/runs/{run_id} | Retrieve call details |
GET | /public/download/workflow/{token}/{artifact_type} | Download recordings and transcripts |
POST | /telephony/inbound/{workflow_id} | Inbound call webhook |
Choose the right public call route#
Paladin exposes two public outbound call route families. They are not interchangeable, even though both path parameters look like UUIDs.
| Use this when | Production route | Test route | Identifier you pass |
|---|---|---|---|
| You added an API Trigger node to the workflow and want to call that trigger | /public/agent/{uuid} | /public/agent/test/{uuid} | The trigger UUID (trigger_path) from the API Trigger node |
| You want to execute the workflow by its stable Agent UUID instead of a trigger node | /public/agent/workflow/{workflow_uuid} | /public/agent/test/workflow/{workflow_uuid} | The workflow UUID from the agent's Agent UUID field |
Once Paladin resolves the target agent, both route families behave the same:
- They accept the same request body
- They return the same response shape
- They validate the same
X-API-Keyorganization boundary - They use the same telephony configuration selection rules
If you specifically need the API Trigger route, see Trigger an outbound call by API Trigger node. To execute by workflow UUID, see Trigger an outbound call by workflow UUID.
Using initial context#
initial_context passes runtime data into the agent at call time. Values are available as template variables in your agent's prompt using double-brace syntax.
json
{
"initial_context": {
"customer_name": "Jane",
"appointment_date": "March 15"
}
}Your agent prompt can then reference {{customer_name}} and {{appointment_date}} and they will be substituted when the call starts.
Run status values#
| Status | Description |
|---|---|
pending | Call queued but not yet connected |
in_progress | Call is live |
completed | Call ended normally |
failed | Call failed before or during execution |