Skip to main content
GET
/
api
/
agents
/
{agent_id}
Get Agent
curl --request GET \
  --url https://api.getello.ai/api/agents/{agent_id} \
  --header 'X-API-Key: <api-key>'
{
  "status": 200,
  "message": "Agent retrieved successfully",
  "data": {
    "_id": "683715217c8e5fe1361c6faa",
    "workspaceId": "683578ec8ac922546dbaadaa",
    "name": "My Outbound Agent",
    "type": "outbound",
    "category": "general",
    "description": "AI Agent for voice calls",
    "image": "https://voicemart.ai/assistant-icons/default.png",
    "features": [],
    "popularity": 0,
    "voiceConfig": {
      "provider": "elevenlabs",
      "voiceId": "emily",
      "language": "en-US",
      "patienceLevel": 1,
      "speed": 1,
      "pitch": 1,
      "latency": 0.5,
      "stability": 0.5,
      "styleExaggeration": 0.75,
      "similarity": 0.8,
      "voicePromptType": null,
      "voicePrompt": null
    },
    "aiModel": {
      "provider": "openai",
      "model": "gpt-4",
      "temperature": 0.7,
      "maxTokens": 200
    },
    "callConfig": {
      "timeZone": "UTC",
      "maxDuration": 600,
      "voicemailDetection": {
        "enabled": true,
        "type": "ml-based"
      },
      "recordingEnabled": true,
      "transcriptionEnabled": true,
      "speakerBoost": false,
      "idleReminders": [
        false,
        0.75
      ],
      "backGroundNoiseEnv": null,
      "limitCallDuration": [
        false,
        20
      ],
      "backGroundNoiseLevel": null,
      "backGroundNoiseThreshold": 0.75,
      "backGroundNoiseTimeout": 10,
      "backGroundNoiseTimeoutThreshold": 0.75,
      "backGroundNoiseTimeoutInterval": 10
    },
    "fillerWords": false,
    "status": true,
    "customVocabulary": [],
    "timezone": "India",
    "greeting": "Hello! How can I assist you today?",
    "prompt": "You are a helpful AI assistant focused on providing accurate and friendly responses.",
    "knowledgeBases": [],
    "actions": [],
    "deployment": {
      "status": "draft",
      "version": 1,
      "deployedAt": "2025-05-28T13:52:33.949000",
      "lastUpdated": "2025-05-28T13:52:33.949000",
      "error": null
    },
    "stats": {
      "totalCalls": 0,
      "successRate": 1,
      "avgCallDuration": 0,
      "lastCallAt": null
    },
    "templateCategory": null,
    "industry": null,
    "recommendedActions": [],
    "createdAt": "2025-05-28T13:52:33.951000",
    "updatedAt": "2025-05-28T13:52:33.951000"
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

agent_id
string
required

Unique identifier of the agent (e.g., 683715217c8e5fe1361c6faa)

Response

Agent retrieved successfully

status
integer
Example:

200

message
string
Example:

"Agent retrieved successfully"

data
object