GET
/
v1
/
agents
/
{agent_id}
/
details
Get Agent 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

X-API-KEY
string
header
required

Path Parameters

agent_id
string
required
Required string length: 24

Response

Successful Response

id
string
required
account_id
string
required
name
string
required
avatar
string
required
voice_audio_id
string
required
roles
RoleModel · object[]
required
personality
object
required

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.

enabled
boolean
required
actions
ActionModel · object[] | null
script
object | null

Container for a single script record.

Example:
{
"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[] | null
greetings
string[] | null
interruptions
string[] | null
history
object | null
greeting_type_inbound
enum<string>
Available options:
static,
ai,
none
greeting_type_outbound
enum<string>
Available options:
static,
ai,
none
structured_greetings
StructuredGreetingModel · object[] | null
tts_settings
object | null