Skip to main content
ActionsVersion: v3

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:voice-ai-agent-goals.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Body

agentIdstringrequired

Agent ID to attach the action to

Example:507f1f77bcf86cd799439011
locationIdstringrequired

Location ID

Example:507f1f77bcf86cd799439012
actionTypestringrequired

Type of action

Available optionsCALL_TRANSFERDATA_EXTRACTIONIN_CALL_DATA_EXTRACTIONWORKFLOW_TRIGGERSMSAPPOINTMENT_BOOKINGCUSTOM_ACTIONKNOWLEDGE_BASE
Example:CALL_TRANSFER
namestringrequired

Human-readable name for this action

Example:Transfer to Manager
actionParametersobjectrequired

Action parameters - structure varies by actionType

Response

Action created successfully

idstringrequired

Unique identifier for the created action

Example:507f1f77bcf86cd799439011
actionTypestringrequired

Type of action

Available optionsCALL_TRANSFERDATA_EXTRACTIONIN_CALL_DATA_EXTRACTIONWORKFLOW_TRIGGERSMSAPPOINTMENT_BOOKINGCUSTOM_ACTIONKNOWLEDGE_BASE
Example:CALL_TRANSFER
namestringrequired

Human-readable name for this action

Example:Transfer to Manager
actionParametersobjectrequired

Action parameters - structure varies by actionType