Skip to main content
Version: v3

Create Agent

POST 
/voice-ai/agents

Create a new voice AI agent configuration and settings

Request​

Version stringrequired

API Version

Available optionsv3
application/json

Bodyrequired

    locationIdstringrequired

    Unique identifier for the location where this agent will operate

    agentNamestring

    Display name for the voice AI agent, between 1-40 characters. Default: "My Agent {random 3 digit number}"

    Possible values: non-empty and <= 40 characters

    businessNamestring

    Name of the business this agent represents. Default: Uses location name

    Possible values: non-empty

    welcomeMessagestring

    Initial greeting spoken when the agent answers calls. Default: Auto generated

    Possible values: non-empty and <= 190 characters

    agentPromptstring

    Custom instructions defining the agent's behavior and personality. Default: Basic prompt generated automatically

    voiceIdstring

    Identifier for the speech synthesis voice from available voice options. Default: Auto generated

    languageVoiceAILanguage

    Language code for the agent's speech and understanding. Default: "en-US"

    Available optionsen-USpt-BResfrdeitnl-NLmulti
    patienceLevelPatienceLevel

    Tolerance level for caller response delays. Default: "high"

    Available optionslowmediumhigh
    maxCallDurationnumber

    Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes)

    Possible values: >= 180 and <= 900

    sendUserIdleRemindersboolean

    Enables automatic reminders when callers are silent. Default: true

    reminderAfterIdleTimeSecondsnumber

    Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds

    Possible values: >= 1 and <= 20

    inboundNumberstring

    Phone number for receiving inbound calls to this agent. Default: null

    numberPoolIdstring

    Identifier for the number pool managing phone number allocation. Default: null

    callEndWorkflowIdsstring[]

    Array of workflow IDs to trigger automatically when calls end. Default: []

    Possible values: <= 10

    sendPostCallNotificationToobject

    Configuration for post-call email notifications to various recipients. Default: []

    agentWorkingHoursobject[]

    Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7)

    timezonestring

    IANA timezone identifier affecting working hours and scheduling. Default: Location timezone

    Possible values: Value must match regular expression ^[A-Za-z_]+/[A-Za-z_]+$

    isAgentAsBackupDisabledboolean

    Prevents this agent from being used as a fallback option. Default: false (Available as backup agent)

    translationobject

    Language translation settings including enablement flag and target language code. Rules: (1) translation.enabled can only be true if the agent's language is not en-US; (2) when enabled, translation.language must be either the agent's language or en-US; (3) when enabled, translation.language is required.

application/json

Agent created successfully

Schema
    idstringrequired

    Unique identifier for the created agent

    locationIdstringrequired

    Unique identifier for the location where this agent operates

    agentNamestringrequired

    Display name of the voice AI agent

    businessNamestringrequired

    Name of the business this agent represents

    welcomeMessagestringrequired

    Greeting message spoken when the agent answers calls

    agentPromptstringrequired

    Custom instructions defining the agent's behavior

    voiceIdstringrequired

    Identifier for the speech synthesis voice being used

    languagestringrequired

    Language code for the agent's speech and understanding

    patienceLevelstringrequired

    Current tolerance level for caller response delays

    maxCallDurationnumberrequired

    Maximum call duration in seconds, between 180-900

    Possible values: >= 180 and <= 900

    sendUserIdleRemindersbooleanrequired

    Indicates whether automatic idle reminders are enabled

    reminderAfterIdleTimeSecondsnumberrequired

    Seconds to wait before sending idle reminders, between 1-20

    Possible values: >= 1 and <= 20

    inboundNumberstring

    Phone number for receiving inbound calls

    numberPoolIdstring

    Identifier for the number pool managing this agent's phone allocation

    callEndWorkflowIdsstring[]

    Array of workflow IDs triggered automatically when calls end

    sendPostCallNotificationToobject

    Current post-call notification settings including recipient configuration

    agentWorkingHoursobject[]

    Time intervals when the agent accepts calls, organized by day of week

    timezonestringrequired

    IANA timezone identifier for working hours and scheduling

    isAgentAsBackupDisabledbooleanrequired

    Indicates whether this agent is excluded from backup scenarios

    translationobject

    Current language translation settings including enablement status and target language