This endpoint allows you to create a new AI assistant with comprehensive configuration options.
Request Body
Core Required Fields
The name of the assistant (max 255 characters)
The voice ID to use for the assistant (must exist in available voices)
The language name for the assistant (max 100 characters)
The LLM model name to use (max 100 characters)
The call direction type. Options: receive
, make
The engine type to use. Options: pipeline
, multimodal
The timezone for the assistant (e.g., “America/New_York”)
The initial message the assistant will speak when the call starts
The system prompt that defines the assistant’s behavior and personality
Optional Configuration
The ID of a phone number to assign to the assistant (must exist in user’s phone numbers)
Voice activity detection type. Options: vad
, ai
Endpoint sensitivity level (0-5)
Interrupt sensitivity level (0-5)
Ambient sound volume level (0-1)
Whether to enable post-call evaluation
send_webhook_only_on_completed
Whether to send webhooks only on completed calls
include_recording_in_webhook
Whether to include recording URL in webhook payload
Webhook Configuration
Whether webhook notifications are enabled
The webhook URL for post-call notifications (required if is_webhook_active is true)
Interruption Settings
Whether to use minimum interrupt words setting
Minimum number of words before interruption is allowed (0-10)
Variables and Schema
Key-value pairs of custom variables for the assistant
Schema definition for post-call data extractionShow post_call_schema properties
The name of the schema field (alphanumeric and underscores only)
The data type. Options: string
, number
, bool
post_call_schema[].description
Description of what this field represents
end_call_tool.description
Description for the end call tool functionality (max 500 characters)
Voice and Speech Settings
LLM temperature setting (0-1)
Voice stability setting (0-1)
Voice similarity setting (0-1)
Speech speed multiplier (0.7-1.2)
Call Behavior Settings
Whether to allow caller interruptions
Whether to use filler audio during processing
Re-engagement interval in seconds (7-600)
Maximum call duration in seconds (20-1200)
Maximum silence duration in seconds (1-120)
Whether to end call when voicemail is detected
Whether to enable noise cancellation
Whether to record the call
Who speaks first in the call. Options: AI assistant
, Customer
Response
Success message confirming assistant creation
The unique identifier of the created assistant
The name of the assistant
The current status of the assistant
The type of assistant (inbound
or outbound
)
The engine mode (pipeline
or multimodal
)
Error Responses
Error message indicating validation failure
Detailed validation errors for each field
500 Internal Server Error
Error message indicating assistant creation failure
{
"message": "Assistant created successfully",
"data": {
"id": 789,
"name": "Sales Assistant",
"status": "active",
"type": "outbound",
"mode": "pipeline"
}
}
Notes
- All required fields must be provided for successful assistant creation
- The assistant will be created with default settings for any optional fields not specified
- Phone number assignment is optional but the phone number must belong to the authenticated user
- Webhook URL is required only when
is_webhook_active
is set to true
- Voice and language identifiers must correspond to available options in the system