Create a new AI agent.
Creates a new AI agent with the specified configuration. The agent can be configured with multiple channels (website widget, email, SMS, WhatsApp, voice) and custom branding.
Authorizations
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Body
Agent configuration
Request body for creating a new agent
Agent name
URL or base64 avatar image
AI system instructions
Agent-specific prompt
Branding colors: {primary?: string (hex), secondary?: string (hex), background?: string (hex)}
AI model (default: gpt-4o-mini)
Multi-channel configuration: {website?: {enabled: boolean}, email?: {enabled: boolean, address?: string}, sms?: {enabled: boolean, phoneNumber?: string}, whatsapp?: {enabled: boolean, phoneNumber?: string (Twilio WhatsApp-enabled number, E.164), integrationId?: string (Twilio integration ID), autoReply?: boolean}, voice?: {enabled: boolean}}
Lead field definitions: [{name: string, type: string (text, email, phone, number), required?: boolean}]
Smart list ID for contact collection
Whether AI passively extracts contact info from conversations (default: true)
Whether agent is active (default: true)
Whether the agent answers from the knowledge base
Knowledge base folder the agent is limited to (e.g. / or /shared/Support)
Whether the agent can chain multiple tool-calling turns (knowledge base search, MCP servers, integration toolsets) instead of a single round
Tool-calling turns allowed before tools are removed and the agent must answer (1-10, default 5)
Response
The created agent
Agent object
Agent ID
Agent name
URL or base64 avatar image
AI system instructions
Agent-specific prompt
Branding colors configuration
AI model
Multi-channel configuration
Lead field definitions
Smart list ID
Whether AI passively extracts contact info from conversations
Whether agent is active
Whether the agent answers from the knowledge base
Knowledge base folder the agent is limited to (e.g. / or /shared/Support)
Whether the agent can chain multiple tool-calling turns (knowledge base search, MCP servers, integration toolsets) instead of a single round
Tool-calling turns allowed before tools are removed and the agent must answer (1-10, default 5)
Shareable URL code
Creation timestamp
Last update timestamp

