Skip to main content
GET
/
v1
/
agents
/
{agent_id}
Get Agent
curl --request GET \
  --url https://api.eqho.ai/v1/agents/{agent_id} \
  --header 'X-API-KEY: <api-key>'
{
  "avatar": "WOMAN",
  "data_store_ids": [
    "65a9758171f55af646a19890"
  ],
  "description": "An agent that the sales team is testing.",
  "greeting_type_inbound": "static",
  "greeting_type_outbound": "ai",
  "name": "Liz",
  "personality": {
    "adherence": 0.75,
    "empathy": 0.5,
    "humor": 0.25
  },
  "role_ids": [
    "65a9758171f55af646a19890"
  ],
  "script_id": "65a9758171f55af646a19890",
  "structured_greetings": [
    {
      "call_type": "inbound",
      "greeting_type": "static",
      "text": "Hello! Welcome to our service. How can I assist you today?"
    },
    {
      "call_type": "outbound",
      "communication_tone": "friendly",
      "greeting_length": "short",
      "greeting_type": "ai",
      "mention_ids": [
        "673e488ce7d69488a458cf3e",
        "973e488ce7d69488a458cf3e"
      ]
    }
  ],
  "voice_audio_id": "Y94lg6clSowTJ0jJOlyc"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
agent_id
string
required
Required string length: 24

Response

Successful Response

Container for a single agent record.

​
name
string | null
​
language
enum<string>

Language codes that are supported by Eqho Agents.

Available options:
multi,
bg,
ca,
cs,
da,
da-DK,
de,
de-CH,
el,
en,
en-US,
en-AU,
en-GB,
en-NZ,
en-IN,
es,
et,
fi,
fr,
fr-CA,
hi,
hu,
id,
it,
ja,
lt,
lv,
no,
nl,
pl,
pt,
pt-BR,
pt-PT,
ro,
ru,
sk,
th,
th-TH,
tr,
uk,
vi,
zh,
zh-CN,
zh-TW,
zh-HK
​
description
string | null
​
avatar
string | null
​
voice_audio_id
string | null
​
role_ids
string[] | null
​
action_ids
string[] | null
​
action_flows
string[][] | null
​
script_id
string | null
deprecated

Deprecated. Use script_ids instead.

​
script_ids
string[] | null
​
data_store_ids
string[] | null
​
personality
object | null

Describes the personality of an agent. These values will be injected into the agent's prompt. LLM might use them to adjust the agent's responses.

​
disable_greeting
boolean | null
deprecated

Deprecated. This field is no longer recommended for use and will be removed in future versions. Use greeting_type with value 'none' instead.

​
rag_collection
string | null
​
system_prompt
object | null
​
conversation_flow_id
string | null
​
enable_parallel_tool_calls
boolean | null
default:false
​
end_conversation_on_goodbye
boolean | null
​
enable_user_idle_timeout
boolean | null
default:false
​
ai_settings
object | null

Settings for the Agent's LLM model.

​
tts_settings
object | null
​
voice_settings
object | null
​
greeting_type_inbound
enum<string> | null
default:static
Available options:
static,
ai,
none
​
greeting_type_outbound
enum<string> | null
default:static
Available options:
static,
ai,
none
​
structured_greetings
StructuredGreetingModel · object[] | null
​
greetings
string[] | null
deprecated

Deprecated. Use structured_greetings instead.

​
alias
string | null
​
smart_turn_detection
boolean | null
default:false
​
feature_flags
string[] | null
Examples:

"CHAT_HISTORY"

"VAPI_ENABLED"

"CONVERSATION_STREAM"

​
_id
string | null
​
account_id
string | null
​
enabled
boolean | null
default:true
​
history
object