Get Agent

GET 
/voice-ai/agents/:agentId

Retrieve detailed configuration and settings for a specific voice AI agent

Request

Version stringrequired

API Version

Available optionsv3

agentId stringrequired

Unique agent identifier

locationId stringrequired

Location ID

application/json

Agent details retrieved successfully

application/json

Schema

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

actionsobject[]required

Raw actions configured for this agent with complete actionParameters structure

Example (auto)

{
  "id": "507f1f77bcf86cd799439011",
  "locationId": "LOC123456789ABCDEF",
  "agentName": "Customer Support Agent",
  "businessName": "Acme Corporation",
  "welcomeMessage": "Hello! Thank you for calling. How can I assist you today?",
  "agentPrompt": "You are a helpful customer service representative.",
  "voiceId": "507f1f77bcf86cd799439011",
  "language": "en-US",
  "patienceLevel": "medium",
  "maxCallDuration": 600,
  "sendUserIdleReminders": true,
  "reminderAfterIdleTimeSeconds": 5,
  "inboundNumber": "+1234567890",
  "numberPoolId": "pool_507f1f77bcf86cd799439011",
  "callEndWorkflowIds": [],
  "sendPostCallNotificationTo": {
    "admins": true,
    "allUsers": false,
    "contactAssignedUser": false,
    "specificUsers": [],
    "customEmails": []
  },
  "agentWorkingHours": [],
  "timezone": "America/New_York",
  "isAgentAsBackupDisabled": false,
  "translation": {
    "enabled": false,
    "language": "es"
  },
  "actions": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "actionType": "CALL_TRANSFER",
      "name": "Transfer to Manager",
      "actionParameters": {
        "triggerPrompt": "When caller asks for manager",
        "triggerMessage": "Let me transfer you",
        "transferToType": "number",
        "transferToValue": "+1234567890"
      }
    }
  ]
}