Skip to content

calls.startTest

Place a test call that runs the draft.

Reference

POST/api/v1/public/agent/test/{uuid}

Auth
API key in X-API-Key
Content
application/json
Returns
200 · TriggerCallResponse

Initiate a phone call against the latest draft of the agent. Useful for verifying changes before publishing. Falls back to the published definition when no draft exists.

Arguments

ArgumentInTypeRequiredDescription
uuidpathstringrequired
phone_numberbodystringrequired
initial_contextbodyobjectoptional
telephony_configuration_idbodyintegeroptional
event_idbodystringoptionalAn identifier for the event that caused this call. A second request carrying the same event_id within 24 hours returns the first call instead of placing another.

Example request

curl -X POST "https://api.decibyl.ai/api/v1/public/agent/test/<uuid>" \
  -H "X-API-Key: dcb_your_key" \
  -H "Content-Type: application/json" \
  -d '{"phone_number":"string","initial_context":{},"telephony_configuration_id":1,"event_id":"string"}'

Response

{
  "status": "string",
  "workflow_run_id": 1,
  "workflow_run_name": "string"
}

Errors

StatusWhen
404Not found
422Validation Error