Create agent
Creates a new AI voice agent with the specified configuration. The system automatically generates a unique agent ID and assigns infrastructure resources. The response includes the created agent with all assigned infrastructure details and generated identifiers.
Before You Begin
- Media files for hold music or background sounds must be uploaded first
- Pronunciation dictionaries must be created if referenced
- SIP configuration must be set up if using warm transfer
Required Configuration
At minimum, you must provide:- Agent name (unique within your organization)
- Voice configuration (voice ID and language)
- TTS (Text-to-Speech) configuration
Body
Agent configuration
Request to create or update an agent with full configuration including name, description, behavior settings, call schedule, and inbound routing. Contains all agent properties such as enabled status, display name, optional description, complete agent configuration (TTS, LLM, STT, outbound SIP for making calls, webhooks, features, MCP connections, tools), default prompt variables in AdditionalData, time-based schedule for when outbound calls can be made, and inbound call routing configuration.
Display name for the agent. Used to identify the agent in the UI, logs, and API responses.
1 - 100Complete configuration for the agent's behavior including voice settings (TTS), language model (LLM), speech recognition (STT), outbound SIP configuration for making calls, webhooks for event notifications, features like RAG and transfers, MCP connections for external services, and custom tools. This defines how the agent will interact during conversations and what capabilities it has.
Whether the agent is enabled and can handle calls. When disabled, the agent cannot make outbound calls or handle inbound routing.
Optional description explaining the agent's purpose, behavior, or use case. Useful for documentation and team collaboration to understand what this agent is designed to do.
Default data for variable interpolation in agent prompts. Values can be referenced in prompts using {{variableName}} syntax. These serve as default values for the agent and can be overridden on a per-call basis when enqueueing calls.
Time-based schedule defining when the agent can make outbound calls. Specifies available time slots for each day of the week and the timezone for schedule interpretation. Scheduled calls will only be placed during these time windows.
Configuration for routing inbound calls to this agent. To configure phone number routing for incoming calls, use the SIP phone numbers API to assign a phone number to this agent instead of using this field directly.
Response
Agent created successfully
Complete agent details including all configuration, identifiers, timestamps, schedule, and inbound routing. Contains the full agent state including enabled status, display name, optional description, complete agent configuration (TTS, LLM, STT, outbound SIP for making calls, webhooks, features, MCP connections, tools), default prompt variables in AdditionalData, unique identifiers, creation and update timestamps, call schedule for outbound calls, and inbound call routing configuration.
Display name for the agent. Used to identify the agent in the UI, logs, and API responses.
1 - 100Complete configuration for the agent's behavior including voice settings (TTS), language model (LLM), speech recognition (STT), outbound SIP configuration for making calls, webhooks for event notifications, features like RAG and transfers, MCP connections for external services, and custom tools. This defines how the agent will interact during conversations and what capabilities it has.
Unique identifier for the agent. Use this ID to reference the agent in API calls, call enqueueing, and WebSocket connections.
1Organization identifier that owns this agent. All resources and calls for this agent are scoped to this organization.
1Timestamp when the agent was created. Recorded in UTC.
Timestamp when the agent was last updated. Recorded in UTC and updated whenever any agent configuration changes.
Inbound call routing configuration showing which phone number routes incoming calls to this agent. Includes the unique configuration ID, assigned phone number, SIP URI for routing, and trunk URI. To modify phone number routing, use the SIP phone numbers API.
Time-based schedule defining when the agent can make outbound calls. Specifies available time slots for each day of the week and the timezone for schedule interpretation. Scheduled calls will only be placed during these time windows.
Whether the agent is enabled and can handle calls. When disabled, the agent cannot make outbound calls or handle inbound routing.
Optional description explaining the agent's purpose, behavior, or use case. Useful for documentation and team collaboration to understand what this agent is designed to do.
Default data for variable interpolation in agent prompts. Values can be referenced in prompts using {{variableName}} syntax. These serve as default values for the agent and can be overridden on a per-call basis when enqueueing calls.