Agents
Get Agent Details
API Reference
Endpoints
- Actions
- Agents
- Call Now
- Calls
- Campaigns
- Chat
- Chat Widget
- Knowledge Base
- Dispositions
- Lead Lists
- Leads
- Mentions
- Phone Numbers
- Reports
- Roles
- Scripts
- Voices
- Webhooks
Agents
Get Agent Details
GET
/
v1
/
agents
/
{agent_id}
/
details
curl --request GET \
--url https://api.eqho.ai/v1/agents/{agent_id}/details \
--header 'X-API-KEY: <api-key>'
{
"id": "<string>",
"account_id": "<string>",
"name": "<string>",
"avatar": "<string>",
"voice_audio_id": "<string>",
"roles": [
{
"description": "Help customers with their problems and concerns.",
"markdown": {
"sections": [
{
"content": "Help customers with their problems and concerns.",
"level": 2,
"subsections": [
{
"content": "Help customers with their problems and concerns.",
"level": 3,
"title": "Subsection 1"
}
],
"title": "Instructions"
}
]
},
"name": "Customer Support"
}
],
"actions": [
{
"name": "<string>",
"slug": "<string>",
"instructions": "<string>",
"messages": {
"start": "<string>",
"completed": "<string>",
"failed": "<string>",
"delayed": "<string>"
},
"minimum_execution_time_milliseconds": 123,
"delayed_timing_milliseconds": 123,
"type": "call_transfer",
"is_async": true,
"settings": {},
"execution_type": "live",
"response_mode": "interactive",
"execution_order": 123,
"_id": "<string>",
"account_id": "<string>",
"enabled": true,
"history": {
"revision": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"last_modified_by": "<string>"
}
}
],
"script": {
"lines": [
{
"message": "Hi [prospectName]",
"speaker": "AGENT"
},
{
"message": "*Wait for user response*",
"speaker": "USER"
},
{
"message": "My name is [agentName] from [companyName]. I'm just giving you a quick call back with the free debt relief quote you requested! Let's get started, it will only take a few minutes.",
"speaker": "AGENT"
}
],
"name": "Debt Relief Script"
},
"data_stores": [
"<string>"
],
"personality": {
"adherence": 0.75,
"empathy": 0.5,
"humor": 0.25
},
"greetings": [
"<string>"
],
"interruptions": [
"<string>"
],
"history": {
"revision": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"last_modified_by": "<string>"
},
"greeting_type_inbound": "static",
"greeting_type_outbound": "static",
"structured_greetings": [
{
"call_type": "inbound",
"greeting_type": "static",
"text": "Hello! Welcome to our service. How can I assist you today?"
}
],
"enabled": true,
"tts_settings": {
"utterance_end_ms": "1000",
"smart_format": false,
"profanity_filter": false,
"punctuate": true,
"numerals": false,
"keywords": [
"<string>"
],
"diarize": false,
"dictation": false,
"endpointing": "10",
"filler_words": false
}
}
Authorizations
Path Parameters
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.eqho.ai/v1/agents/{agent_id}/details \
--header 'X-API-KEY: <api-key>'
{
"id": "<string>",
"account_id": "<string>",
"name": "<string>",
"avatar": "<string>",
"voice_audio_id": "<string>",
"roles": [
{
"description": "Help customers with their problems and concerns.",
"markdown": {
"sections": [
{
"content": "Help customers with their problems and concerns.",
"level": 2,
"subsections": [
{
"content": "Help customers with their problems and concerns.",
"level": 3,
"title": "Subsection 1"
}
],
"title": "Instructions"
}
]
},
"name": "Customer Support"
}
],
"actions": [
{
"name": "<string>",
"slug": "<string>",
"instructions": "<string>",
"messages": {
"start": "<string>",
"completed": "<string>",
"failed": "<string>",
"delayed": "<string>"
},
"minimum_execution_time_milliseconds": 123,
"delayed_timing_milliseconds": 123,
"type": "call_transfer",
"is_async": true,
"settings": {},
"execution_type": "live",
"response_mode": "interactive",
"execution_order": 123,
"_id": "<string>",
"account_id": "<string>",
"enabled": true,
"history": {
"revision": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"last_modified_by": "<string>"
}
}
],
"script": {
"lines": [
{
"message": "Hi [prospectName]",
"speaker": "AGENT"
},
{
"message": "*Wait for user response*",
"speaker": "USER"
},
{
"message": "My name is [agentName] from [companyName]. I'm just giving you a quick call back with the free debt relief quote you requested! Let's get started, it will only take a few minutes.",
"speaker": "AGENT"
}
],
"name": "Debt Relief Script"
},
"data_stores": [
"<string>"
],
"personality": {
"adherence": 0.75,
"empathy": 0.5,
"humor": 0.25
},
"greetings": [
"<string>"
],
"interruptions": [
"<string>"
],
"history": {
"revision": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"last_modified_by": "<string>"
},
"greeting_type_inbound": "static",
"greeting_type_outbound": "static",
"structured_greetings": [
{
"call_type": "inbound",
"greeting_type": "static",
"text": "Hello! Welcome to our service. How can I assist you today?"
}
],
"enabled": true,
"tts_settings": {
"utterance_end_ms": "1000",
"smart_format": false,
"profanity_filter": false,
"punctuate": true,
"numerals": false,
"keywords": [
"<string>"
],
"diarize": false,
"dictation": false,
"endpointing": "10",
"filler_words": false
}
}