Get Agent

cURL

curl --request GET \
  --url https://app.closerx.ai/api/agent/update/{agent_id}/ \
  --header 'Company-Name: <company-name>' \
  --header 'api_key: <api-key>'

{
  "success": true,
  "message": "get agent detail",
  "data": {
    "pk": 521,
    "agent_name": "add_agent_name",
    "agent_id": "agent_aa2c4c2895abe6ab7c0e89b607",
    "voice_id": "11labs-Marissa",
    "language": "en-US",
    "interruption_sensitivity": "1.0",
    "voicemail": true,
    "voicemail_message": null,
    "end_call_after_silence": 10,
    "max_call_duration": 10,
    "reminder_trigger": 10,
    "ambient_sound": null,
    "analysis_data": [],
    "llm": 527,
    "voice_speed": 1,
    "voice_temperature": 1,
    "volume": 1,
    "enable_backchannel": true,
    "normalize_for_speech": false,
    "enable_transcription_formatting": true,
    "reminder_trigger_ms": 10000,
    "reminder_max_count": 1,
    "boosted_keywords": [],
    "ambient_sound_volume": 1,
    "voicemail_detection_timeout_ms": 5000,
    "begin_message_delay_ms": 0,
    "updated_at": "2025-08-13T09:41:44.564571Z",
    "is_locked": false,
    "calendar_id": null,
    "inbound_appoitment": false,
    "ring_duration_sec": 30,
    "stt_mode": "fast",
    "backchannel_words": null,
    "backchannel_frequency": 0.8,
    "call_scheduling": false,
    "agent_crm_type": null,
    "voicemail_option": {
      "action": {
        "type": "hangup"
      }
    },
    "pronunciation_dictionary": [
      {
        "word": "hello",
        "alphabet": "CMU",
        "phoneme": "<string>"
      }
    ],
    "vocab_specialization": "general",
    "allow_user_dtmf": true,
    "user_dtmf_options": {
      "digit_limit": 123,
      "timeout_ms": 123,
      "termination_key": "<string>"
    },
    "denoising_mode": "noise-cancellation"
  },
  "voice_list": [
    {
      "id": 3,
      "voice_name": "aicall_ryan",
      "voice_id": "custom_voice_937c75901acb54b42837d3dafa",
      "preview_audio_url": "https://aicall-utils-public.s3.us-west-2.amazonaws.com/custom_voice_937c75901acb54b42837d3dafa.mp3",
      "created_at": "2025-08-01T16:31:51.688674Z",
      "updated_at": "2025-08-01T16:31:51.688683Z"
    }
  ],
  "ghl_data": {
    "ghl_connection": true,
    "ghl_book_meeting": true,
    "inbound_appoitment": false,
    "calendar_id": null
  }
}

GET

agent

update

{agent_id}

cURL

curl --request GET \
  --url https://app.closerx.ai/api/agent/update/{agent_id}/ \
  --header 'Company-Name: <company-name>' \
  --header 'api_key: <api-key>'

{
  "success": true,
  "message": "get agent detail",
  "data": {
    "pk": 521,
    "agent_name": "add_agent_name",
    "agent_id": "agent_aa2c4c2895abe6ab7c0e89b607",
    "voice_id": "11labs-Marissa",
    "language": "en-US",
    "interruption_sensitivity": "1.0",
    "voicemail": true,
    "voicemail_message": null,
    "end_call_after_silence": 10,
    "max_call_duration": 10,
    "reminder_trigger": 10,
    "ambient_sound": null,
    "analysis_data": [],
    "llm": 527,
    "voice_speed": 1,
    "voice_temperature": 1,
    "volume": 1,
    "enable_backchannel": true,
    "normalize_for_speech": false,
    "enable_transcription_formatting": true,
    "reminder_trigger_ms": 10000,
    "reminder_max_count": 1,
    "boosted_keywords": [],
    "ambient_sound_volume": 1,
    "voicemail_detection_timeout_ms": 5000,
    "begin_message_delay_ms": 0,
    "updated_at": "2025-08-13T09:41:44.564571Z",
    "is_locked": false,
    "calendar_id": null,
    "inbound_appoitment": false,
    "ring_duration_sec": 30,
    "stt_mode": "fast",
    "backchannel_words": null,
    "backchannel_frequency": 0.8,
    "call_scheduling": false,
    "agent_crm_type": null,
    "voicemail_option": {
      "action": {
        "type": "hangup"
      }
    },
    "pronunciation_dictionary": [
      {
        "word": "hello",
        "alphabet": "CMU",
        "phoneme": "<string>"
      }
    ],
    "vocab_specialization": "general",
    "allow_user_dtmf": true,
    "user_dtmf_options": {
      "digit_limit": 123,
      "timeout_ms": 123,
      "termination_key": "<string>"
    },
    "denoising_mode": "noise-cancellation"
  },
  "voice_list": [
    {
      "id": 3,
      "voice_name": "aicall_ryan",
      "voice_id": "custom_voice_937c75901acb54b42837d3dafa",
      "preview_audio_url": "https://aicall-utils-public.s3.us-west-2.amazonaws.com/custom_voice_937c75901acb54b42837d3dafa.mp3",
      "created_at": "2025-08-01T16:31:51.688674Z",
      "updated_at": "2025-08-01T16:31:51.688683Z"
    }
  ],
  "ghl_data": {
    "ghl_connection": true,
    "ghl_book_meeting": true,
    "inbound_appoitment": false,
    "calendar_id": null
  }
}

Authorizations

api_key

string

header

required

Headers

Company-Name

string

required

The name of the schema to be used for the request

Path Parameters

agent_id

string

required

Unique identifier for the AI call agent to retrieve

Example:

"16b980523634a6dc504898cda492e939"

Response

AI call agent retrieval response

success

boolean

required

Indicates whether the request was successful

Example:

true

message

string

required

Message describing the result of the request

Example:

"get agent detail"

data

object

required

Show child attributes

data.pk

integer

required

Primary key for the AI call agent

Example:

521

data.agent_name

string

required

Name of the AI call agent

Example:

"add_agent_name"

data.agent_id

string

required

Unique identifier for the AI call agent

Example:

"agent_aa2c4c2895abe6ab7c0e89b607"

data.voice_id

string

required

Identifier for the voice used by the agent

Example:

"11labs-Marissa"

data.language

string

required

Language code or type (e.g., en-US, multi)

Example:

"en-US"

data.interruption_sensitivity

string

required

Sensitivity level for interruptions

Example:

"1.0"

data.voicemail

boolean

required

Indicates if voicemail is enabled

Example:

true

data.voicemail_message

string | null

required

Voicemail message content

Example:

null

data.end_call_after_silence

integer

required

Duration of silence before ending the call (in seconds)

Example:

10

data.max_call_duration

integer

required

Maximum call duration (in minutes)

Example:

10

data.reminder_trigger

integer

required

Time before triggering a reminder (in seconds)

Example:

10

data.ambient_sound

string | null

required

Ambient sound setting

Example:

null

data.analysis_data

string[]

required

Data for call analysis

Example:

[]

data.llm

integer

required

Identifier for the language model used

Example:

527

data.voice_speed

number<float>

required

Speed of the voice

Example:

1

data.voice_temperature

number<float>

required

Temperature setting for voice generation

Example:

1

data.volume

number<float>

required

Volume level for the voice

Example:

1

data.enable_backchannel

boolean

required

Indicates if backchannel responses are enabled

Example:

true

data.normalize_for_speech

boolean

required

Indicates if speech normalization is enabled

Example:

false

data.enable_transcription_formatting

boolean

required

Indicates if transcription formatting is enabled

Example:

true

data.reminder_trigger_ms

integer

required

Reminder trigger time in milliseconds

Example:

10000

data.reminder_max_count

integer

required

Maximum number of reminders

Example:

1

data.boosted_keywords

string[]

required

List of keywords to boost in processing

Example:

[]

data.ambient_sound_volume

number<float>

required

Volume level for ambient sound

Example:

1

data.voicemail_detection_timeout_ms

integer

required

Timeout for voicemail detection in milliseconds

Example:

5000

data.begin_message_delay_ms

integer

required

Delay before starting message in milliseconds

Example:

0

data.updated_at

string<date-time>

required

Timestamp when the agent was last updated

Example:

"2025-08-13T09:41:44.564571Z"

data.is_locked

boolean

required

Indicates if the agent is locked

Example:

false

data.calendar_id

string | null

required

Identifier for associated calendar

Example:

null

data.inbound_appoitment

boolean

required

Indicates if inbound appointment scheduling is enabled

Example:

false

data.ring_duration_sec

integer

required

Ring duration in seconds

Example:

30

data.stt_mode

string

required

Speech-to-text mode (e.g., fast)

Example:

"fast"

data.backchannel_words

string | null

required

Words used for backchannel responses

Example:

null

data.backchannel_frequency

number<float>

required

Frequency of backchannel responses

Example:

0.8

data.call_scheduling

boolean

required

Indicates if call scheduling is enabled

Example:

false

data.agent_crm_type

string | null

required

Type of CRM integration for the agent

Example:

null

data.voicemail_option

object

required

Voicemail options for the agent

Show child attributes

data.voicemail_option.action

object

Show child attributes

data.voicemail_option.action.type

string

Type of voicemail action (e.g., hangup)

Example:

"hangup"

data.pronunciation_dictionary

object[] | null

List of words/phrases with pronunciations for consistent synthesis. Set to null to remove.

Show child attributes

data.pronunciation_dictionary.word

string

Example:

"hello"

data.pronunciation_dictionary.alphabet

enum<string>

Available options:

CMU,

IPA

data.pronunciation_dictionary.phoneme

string

data.vocab_specialization

enum<string>

Vocabulary set for transcription (English only). Defaults to general.

Available options:

general,

medical

Example:

"general"

data.allow_user_dtmf

boolean

If set to true, DTMF input will be accepted and processed. If false, any DTMF input will be ignored. Default to true.

Example:

true

data.user_dtmf_options

object

DTMF options for the agent.

Show child attributes

data.user_dtmf_options.digit_limit

number

The maximum number of digits allowed in the user's DTMF (Dual-Tone Multi-Frequency) input per turn. Once this limit is reached, the input is considered complete and a response will be generated immediately.

data.user_dtmf_options.timeout_ms

number

The time (in milliseconds) to wait for user DTMF input before timing out. The timer resets with each digit received.

data.user_dtmf_options.termination_key

string

A single key that signals the end of DTMF input. Acceptable values include any digit (0–9), the pound/hash symbol (#), or the asterisk (*).

data.denoising_mode

enum<string>

Denoising mode for audio. Defaults to noise-cancellation.

Available options:

noise-cancellation,

noise-and-background-speech-cancellation

Example:

"noise-cancellation"

voice_list

object[]

required

List of available voices for the agent

Show child attributes

voice_list.id

integer

required

Unique identifier for the voice

Example:

3

voice_list.voice_name

string

required

Name of the voice

Example:

"aicall_ryan"

voice_list.voice_id

string

required

Unique identifier for the voice

Example:

"custom_voice_937c75901acb54b42837d3dafa"

voice_list.preview_audio_url

string<uri>

required

URL to the voice's preview audio

Example:

"https://aicall-utils-public.s3.us-west-2.amazonaws.com/custom_voice_937c75901acb54b42837d3dafa.mp3"

voice_list.created_at

string<date-time>

required

Timestamp when the voice was created

Example:

"2025-08-01T16:31:51.688674Z"

voice_list.updated_at

string<date-time>

required

Timestamp when the voice was last updated

Example:

"2025-08-01T16:31:51.688683Z"

ghl_data

object

required

Show child attributes

ghl_data.ghl_connection

boolean

required

Indicates if GoHighLevel is connected

Example:

true

ghl_data.ghl_book_meeting

boolean

required

Indicates if meeting booking is enabled

Example:

true

ghl_data.inbound_appoitment

boolean

required

Indicates if inbound appointment scheduling is enabled

Example:

false

ghl_data.calendar_id

string | null

required

Identifier for associated calendar

Example:

null

Create Agent Get LLM

⌘I

API Documentation

Authentication

Dashboard Data

Agent

Campaign

Callbacks

Contact

Phone Number

Integrations

Billing & Subscription

Credits

Authorizations

Headers

Path Parameters

Response