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.",
      "name": "Customer Support"
    }
  ],
  "personality": {
    "adherence": 0.75,
    "empathy": 0.5,
    "humor": 0.25
  },
  "enabled": true,
  "actions": [
    {
      "name": "<string>",
      "slug": "<string>",
      "instructions": "<string>",
      "type": "call_transfer",
      "settings": {},
      "messages": {
        "start": "<string>",
        "completed": "<string>",
        "failed": "<string>",
        "delayed": "<string>"
      },
      "minimum_execution_time_milliseconds": 123,
      "delayed_timing_milliseconds": 123,
      "is_async": false,
      "non_live_llm_settings": {
        "model": "gpt-4o-mini",
        "temperature": 0
      },
      "execution_type": "live",
      "response_mode": "interactive",
      "execution_order": 123,
      "_id": "<string>",
      "account_id": "<string>",
      "enabled": true,
      "history": {
        "last_modified_at": "2023-11-07T05:31:56Z",
        "revision": 0,
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "unknown",
        "last_modified_by": "unknown"
      }
    }
  ],
  "scripts": [
    {
      "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"
    }
  ],
  "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>"
  ],
  "greetings": [
    "<string>"
  ],
  "interruptions": [
    "<string>"
  ],
  "history": {
    "last_modified_at": "2023-11-07T05:31:56Z",
    "revision": 0,
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "unknown",
    "last_modified_by": "unknown"
  },
  "greeting_type_inbound": "static",
  "greeting_type_outbound": "static",
  "structured_greetings": [
    {
      "call_type": "outbound",
      "text": "<string>",
      "static_greetings_per_medium": {},
      "greeting_type": "ai",
      "communication_tone": "business_casual",
      "greeting_length": "medium",
      "examples": [
        "<string>"
      ],
      "additional_prompt_context": "<string>",
      "language": "en",
      "mention_ids": [
        "<string>"
      ]
    }
  ],
  "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
  }
}

GET

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.",
      "name": "Customer Support"
    }
  ],
  "personality": {
    "adherence": 0.75,
    "empathy": 0.5,
    "humor": 0.25
  },
  "enabled": true,
  "actions": [
    {
      "name": "<string>",
      "slug": "<string>",
      "instructions": "<string>",
      "type": "call_transfer",
      "settings": {},
      "messages": {
        "start": "<string>",
        "completed": "<string>",
        "failed": "<string>",
        "delayed": "<string>"
      },
      "minimum_execution_time_milliseconds": 123,
      "delayed_timing_milliseconds": 123,
      "is_async": false,
      "non_live_llm_settings": {
        "model": "gpt-4o-mini",
        "temperature": 0
      },
      "execution_type": "live",
      "response_mode": "interactive",
      "execution_order": 123,
      "_id": "<string>",
      "account_id": "<string>",
      "enabled": true,
      "history": {
        "last_modified_at": "2023-11-07T05:31:56Z",
        "revision": 0,
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "unknown",
        "last_modified_by": "unknown"
      }
    }
  ],
  "scripts": [
    {
      "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"
    }
  ],
  "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>"
  ],
  "greetings": [
    "<string>"
  ],
  "interruptions": [
    "<string>"
  ],
  "history": {
    "last_modified_at": "2023-11-07T05:31:56Z",
    "revision": 0,
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "unknown",
    "last_modified_by": "unknown"
  },
  "greeting_type_inbound": "static",
  "greeting_type_outbound": "static",
  "structured_greetings": [
    {
      "call_type": "outbound",
      "text": "<string>",
      "static_greetings_per_medium": {},
      "greeting_type": "ai",
      "communication_tone": "business_casual",
      "greeting_length": "medium",
      "examples": [
        "<string>"
      ],
      "additional_prompt_context": "<string>",
      "language": "en",
      "mention_ids": [
        "<string>"
      ]
    }
  ],
  "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

string

required

account_id

string

required

name

string

required

avatar

string

required

voice_audio_id

string

required

roles

RoleModel · object[]

required

Show child attributes

roles.name

string

required

roles.description

string

required

roles._id

string | null

roles.account_id

string | null

roles.enabled

boolean | null

default:true

roles.history

HistoryModel · object

Show child attributes

roles.history.last_modified_at

string<date-time>

required

roles.history.revision

integer

default:0

roles.history.created_at

string<date-time> | null

roles.history.created_by

string

default:unknown

roles.history.last_modified_by

string

default:unknown

personality

PersonalityModel · 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.

Show child attributes

personality.adherence

number

default:0.75

Script adherence parameter, 0 represents freedom to adjust verbiage, and 1 signifies the exact script word for word flow.

Required range: 0 <= x <= 1

personality.empathy

number

default:0.5

0 represents a lack of empathy, and 1 signifies a high level of empathy.

Required range: 0 <= x <= 1

personality.humor

number

default:0.25

0 represents no humor, and 1 signifies a high level of humor.

Required range: 0 <= x <= 1

enabled

boolean

required

actions

ActionModel · object[] | null

Show child attributes

actions.name

string

required

actions.slug

string

required

actions.instructions

string

required

actions.type

enum<string>

required

Available options:

call_transfer,

terminate_call,

email,

text,

webhook,

custom_call_transfer,

http_request,

gcal_appointment_schedule,

gcal_check_busy_time,

gcal_get_free_slots,

gcal_fetch_appointments,

gcal_cancel_appointment,

gcal_update_appointment,

data_extraction,

set_lead_email,

set_lead_names,

set_lead_timezone

actions.settings

Settings · object

required

actions.messages

ActionMessages · object

Show child attributes

actions.messages.start

string | null

actions.messages.completed

string | null

actions.messages.failed

string | null

actions.messages.delayed

string | null

actions.minimum_execution_time_milliseconds

integer | null

actions.delayed_timing_milliseconds

integer | null

actions.is_async

boolean | null

default:false

actions.non_live_llm_settings

NonLiveActionLLMSettings · object

Show child attributes

actions.non_live_llm_settings.model

enum<string>

default:gpt-4o-mini

Available options:

gpt-3.5-turbo,

gpt-3.5-turbo-1106,

gpt-3.5-turbo-16k,

gpt-3.5-turbo-16k-0613,

gpt-3.5-turbo-0125,

gpt-4o,

gpt-4-1106-preview,

gpt-4o-mini,

gpt-5,

gpt-5-mini,

gpt-5-nano,

gpt-5-chat-latest,

claude-3-5-sonnet-latest,

claude-3-5-haiku-latest,

claude-3-opus-latest,

deepseek-chat,

deepseek-reasoner

actions.non_live_llm_settings.temperature

number

default:0

actions.execution_type

enum<string>

default:live

Available options:

live,

postcall,

on_call_start

actions.response_mode

enum<string>

default:interactive

Available options:

interactive,

silent

actions.execution_order

integer | null

actions._id

string | null

actions.account_id

string | null

actions.enabled

boolean | null

default:true

actions.history

HistoryModel · object

Show child attributes

actions.history.last_modified_at

string<date-time>

required

actions.history.revision

integer

default:0

actions.history.created_at

string<date-time> | null

actions.history.created_by

string

default:unknown

actions.history.last_modified_by

string

default:unknown

scripts

ScriptModel · object[] | null

Show child attributes

scripts.name

string

required

scripts.lines

LineModel · object[]

required

Show child attributes

scripts.lines.speaker

enum<string>

required

Available options:

AGENT,

USER

scripts.lines.message

string

default:""

scripts._id

string | null

scripts.account_id

string | null

scripts.enabled

boolean | null

default:true

scripts.history

HistoryModel · object

Show child attributes

scripts.history.last_modified_at

string<date-time>

required

scripts.history.revision

integer

default:0

scripts.history.created_at

string<date-time> | null

scripts.history.created_by

string

default:unknown

scripts.history.last_modified_by

string

default:unknown

script

ScriptModel · object

deprecated

Container for a single script record.

Show child attributes

script.name

string

required

script.lines

LineModel · object[]

required

Show child attributes

script.lines.speaker

enum<string>

required

Available options:

AGENT,

USER

script.lines.message

string

default:""

script._id

string | null

script.account_id

string | null

script.enabled

boolean | null

default:true

script.history

HistoryModel · object

Show child attributes

script.history.last_modified_at

string<date-time>

required

script.history.revision

integer

default:0

script.history.created_at

string<date-time> | null

script.history.created_by

string

default:unknown

script.history.last_modified_by

string

default:unknown

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

HistoryModel · object

Show child attributes

history.last_modified_at

string<date-time>

required

history.revision

integer

default:0

history.created_at

string<date-time> | null

history.created_by

string

default:unknown

history.last_modified_by

string

default:unknown

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

Show child attributes

structured_greetings.call_type

enum<string>

required

The type of call this greeting is for

Available options:

outbound,

inbound

structured_greetings.text

string | null

The default static greeting text to be used if the user does not provide a greeting text per conversation medium

structured_greetings.static_greetings_per_medium

Static Greetings Per Medium · object

The static greetings for all conversation mediums

Show child attributes

structured_greetings.static_greetings_per_medium.{key}

StaticGreetingModel · object

Show child attributes

structured_greetings.static_greetings_per_medium.{key}.text

string

required

The greeting text

structured_greetings.static_greetings_per_medium.{key}.disabled

boolean

default:false

Whether to disable the static greeting for a specific conversation medium

structured_greetings.greeting_type

enum<string>

default:ai

This will allow us to have multiple types of greetings, to have some disabled, some enabled and allow the user to A/B test different greeting settings

Available options:

static,

ai,

none

structured_greetings.communication_tone

enum<string> | null

default:business_casual

The communication tone for this greeting

Available options:

friend,

business_casual,

business_professional,

formal

structured_greetings.greeting_length

enum<string> | null

default:medium

The desired length of this greeting

Available options:

short,

medium,

long

structured_greetings.examples

string[] | null

Optional examples to guide AI greeting generation

structured_greetings.additional_prompt_context

string | null

Additional context to guide AI greeting generation, for example the name of the agent, the name of the lead, etc. ALWAYS USE the user's first name and last name in the greeting {{lead.first_name}} {{lead.last_name}}

structured_greetings.language

enum<string> | null

default:en

The language of the greeting, set for future use on MultiLingual 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

structured_greetings.mention_ids

string[] | null

The IDs of the mentions to be resolved and provided with value/description in the greeting system prompt

tts_settings

TTSSettings · object

Show child attributes

tts_settings.utterance_end_ms

string

default:1000

tts_settings.smart_format

boolean

default:false

Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability

tts_settings.profanity_filter

boolean

default:false

Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely

tts_settings.punctuate

boolean

default:true

Add punctuation and capitalization to the transcript

tts_settings.numerals

boolean

default:false

Convert numbers from written format to numerical format

tts_settings.keywords

Keywords can boost or suppress specialized terminology and brands

tts_settings.diarize

boolean

default:false

Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0

tts_settings.dictation

boolean

default:false

Identify and extract key entities from content in submitted audio.

tts_settings.endpointing

string

default:10

Indicates how long Deepgram will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing

tts_settings.filler_words

boolean

default:false

Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um'

Delete Agent Try Agent

⌘I

API Reference

Endpoints

Get Agent Details

Authorizations

Path Parameters

Response