Skip to main content

Trigger an Outbound Agent Run by Agent UUID

POST/api/v1/public/agent/workflow/{workflow_uuid}

Initiate a phone call against the published workflow identified by UUID.

cURL example

curl -X POST \
  'http://localhost:8000/api/v1/public/agent/workflow/{workflow_uuid}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Parameters

NameLocationTypeDescription
workflow_uuidrequiredpathstring
X-API-Keyrequiredheaderstring

Request body

application/json
View schema
{
  "$ref": "#/components/schemas/TriggerCallRequest"
}

Responses

200Successful Response
application/json
View schema
{
  "$ref": "#/components/schemas/TriggerCallResponse"
}
404Not found
422Validation Error
application/json
View schema
{
  "$ref": "#/components/schemas/HTTPValidationError"
}