Create Agent Action

POST 
/voice-ai/actions

Create a new action for a voice AI agent. Actions define specific behaviors and capabilities for the agent during calls.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

agentIdstringrequired

Agent ID to attach the action to

locationIdstringrequired

Location ID

actionTypestringrequired
Type of action
Available optionsCALL_TRANSFERDATA_EXTRACTIONIN_CALL_DATA_EXTRACTIONWORKFLOW_TRIGGERSMSAPPOINTMENT_BOOKINGCUSTOM_ACTIONKNOWLEDGE_BASE
namestringrequired

Human-readable name for this action

actionParametersobjectrequired

Action parameters - structure varies by actionType

Example (auto)

{
  "agentId": "507f1f77bcf86cd799439011",
  "locationId": "507f1f77bcf86cd799439012",
  "actionType": "CALL_TRANSFER",
  "name": "Transfer to Manager",
  "actionParameters": {
    "triggerPrompt": "When the caller asks to speak to a manager",
    "transferToType": "number",
    "transferToValue": "+12345678901",
    "triggerMessage": "Let me transfer you to a manager right away",
    "hearWhisperMessage": true
  }
}

application/json

Action created successfully

application/json

Schema

Schema

idstringrequired

Unique identifier for the created action

actionTypestringrequired
Type of action
Available optionsCALL_TRANSFERDATA_EXTRACTIONIN_CALL_DATA_EXTRACTIONWORKFLOW_TRIGGERSMSAPPOINTMENT_BOOKINGCUSTOM_ACTIONKNOWLEDGE_BASE
namestringrequired

Human-readable name for this action

actionParametersobjectrequired

Action parameters - structure varies by actionType

Example (auto)

{
  "id": "507f1f77bcf86cd799439011",
  "actionType": "CALL_TRANSFER",
  "name": "Transfer to Manager",
  "actionParameters": {
    "triggerPrompt": "When the caller asks to speak to a manager",
    "transferToType": "number",
    "transferToValue": "+12345678901",
    "triggerMessage": "Let me transfer you to a manager right away",
    "hearWhisperMessage": true
  }
}