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, 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
Agent-specific prompt
Whether AI passively extracts contact info from conversations (default: true)
URL or base64 avatar image
Multi-channel configuration: {website?: {enabled: boolean}, email?: {enabled: boolean, address?: string}, sms?: {enabled: boolean, phoneNumber?: string}, voice?: {enabled: boolean}}
Smart list ID for contact collection
Branding colors: {primary?: string (hex), secondary?: string (hex), background?: string (hex)}
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)
Lead field definitions: [{name: string, type: string (text, email, phone, number), required?: boolean}]
AI model (default: gpt-4o-mini)
Tool-calling turns allowed before tools are removed and the agent must answer (1-10, default 5)
Whether the agent can chain multiple tool-calling turns (knowledge base search, MCP servers, integration toolsets) instead of a single round
AI system instructions
Response
The created agent
Agent object
Agent-specific prompt
Whether AI passively extracts contact info from conversations
URL or base64 avatar image
Multi-channel configuration
Smart list ID
Creation timestamp
Branding colors configuration
Agent ID
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)
Lead field definitions
AI model
Tool-calling turns allowed before tools are removed and the agent must answer (1-10, default 5)
Whether the agent can chain multiple tool-calling turns (knowledge base search, MCP servers, integration toolsets) instead of a single round
Agent name
Shareable URL code
AI system instructions
Last update timestamp

