Update Agent

cURL

curl --request PATCH \
  --url https://app.closerx.ai/api/agent-llm/ \
  --header 'Company-Name: <company-name>' \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "agent": {
    "agent_name": "Jarvis",
    "voice_id": "11labs-Adrian",
    "voice_temperature": 1,
    "voice_speed": 1,
    "volume": 1,
    "responsiveness": 1,
    "interruption_sensitivity": 1,
    "pronunciation_dictionary": [
      {
        "word": "actually",
        "alphabet": "cmu",
        "phoneme": "ˈæktʃuəli"
      }
    ],
    "enable_backchannel": true,
    "backchannel_frequency": 0.9,
    "backchannel_words": [
      "yeah",
      "uh-huh"
    ],
    "vocab_specialization": "general",
    "allow_user_dtmf": true,
    "user_dtmf_options": {
      "digit_limit": 123,
      "timeout_ms": 123,
      "termination_key": "<string>"
    },
    "denoising_mode": "noise-cancellation",
    "reminder_trigger_ms": 10000,
    "reminder_max_count": 2,
    "ambient_sound": "coffee-shop",
    "ambient_sound_volume": 1,
    "language": "en-US",
    "boosted_keywords": [
      "aicall",
      "kroger"
    ],
    "normalize_for_speech": true,
    "end_call_after_silence_ms": 600000,
    "max_call_duration_ms": 3600000,
    "voicemail_option": {
      "action": {
        "type": "static_text",
        "text": "Please give us a callback tomorrow at 10am."
      }
    },
    "analysis_data": [
      {
        "type": "<string>",
        "name": "<string>",
        "description": "<string>",
        "examples": [
          "<string>"
        ]
      }
    ],
    "ring_duration_ms": 30000
  }
}
'

{
  "agent": {
    "agent_name": "Jarvis",
    "voice_id": "11labs-Adrian",
    "voice_temperature": 1,
    "voice_speed": 1,
    "volume": 1,
    "responsiveness": 1,
    "interruption_sensitivity": 1,
    "pronunciation_dictionary": [
      {
        "word": "actually",
        "alphabet": "cmu",
        "phoneme": "ˈæktʃuəli"
      }
    ],
    "enable_backchannel": true,
    "backchannel_frequency": 0.9,
    "backchannel_words": [
      "yeah",
      "uh-huh"
    ],
    "vocab_specialization": "general",
    "allow_user_dtmf": true,
    "user_dtmf_options": {
      "digit_limit": 123,
      "timeout_ms": 123,
      "termination_key": "<string>"
    },
    "denoising_mode": "noise-cancellation",
    "reminder_trigger_ms": 10000,
    "reminder_max_count": 2,
    "ambient_sound": "coffee-shop",
    "ambient_sound_volume": 1,
    "language": "en-US",
    "boosted_keywords": [
      "aicall",
      "kroger"
    ],
    "normalize_for_speech": true,
    "end_call_after_silence_ms": 600000,
    "max_call_duration_ms": 3600000,
    "voicemail_option": {
      "action": {
        "type": "static_text",
        "text": "Please give us a callback tomorrow at 10am."
      }
    },
    "analysis_data": [
      {
        "type": "<string>",
        "name": "<string>",
        "description": "<string>",
        "examples": [
          "<string>"
        ]
      }
    ],
    "ring_duration_ms": 30000
  }
}

PATCH

agent-llm

cURL

curl --request PATCH \
  --url https://app.closerx.ai/api/agent-llm/ \
  --header 'Company-Name: <company-name>' \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "agent": {
    "agent_name": "Jarvis",
    "voice_id": "11labs-Adrian",
    "voice_temperature": 1,
    "voice_speed": 1,
    "volume": 1,
    "responsiveness": 1,
    "interruption_sensitivity": 1,
    "pronunciation_dictionary": [
      {
        "word": "actually",
        "alphabet": "cmu",
        "phoneme": "ˈæktʃuəli"
      }
    ],
    "enable_backchannel": true,
    "backchannel_frequency": 0.9,
    "backchannel_words": [
      "yeah",
      "uh-huh"
    ],
    "vocab_specialization": "general",
    "allow_user_dtmf": true,
    "user_dtmf_options": {
      "digit_limit": 123,
      "timeout_ms": 123,
      "termination_key": "<string>"
    },
    "denoising_mode": "noise-cancellation",
    "reminder_trigger_ms": 10000,
    "reminder_max_count": 2,
    "ambient_sound": "coffee-shop",
    "ambient_sound_volume": 1,
    "language": "en-US",
    "boosted_keywords": [
      "aicall",
      "kroger"
    ],
    "normalize_for_speech": true,
    "end_call_after_silence_ms": 600000,
    "max_call_duration_ms": 3600000,
    "voicemail_option": {
      "action": {
        "type": "static_text",
        "text": "Please give us a callback tomorrow at 10am."
      }
    },
    "analysis_data": [
      {
        "type": "<string>",
        "name": "<string>",
        "description": "<string>",
        "examples": [
          "<string>"
        ]
      }
    ],
    "ring_duration_ms": 30000
  }
}
'

{
  "agent": {
    "agent_name": "Jarvis",
    "voice_id": "11labs-Adrian",
    "voice_temperature": 1,
    "voice_speed": 1,
    "volume": 1,
    "responsiveness": 1,
    "interruption_sensitivity": 1,
    "pronunciation_dictionary": [
      {
        "word": "actually",
        "alphabet": "cmu",
        "phoneme": "ˈæktʃuəli"
      }
    ],
    "enable_backchannel": true,
    "backchannel_frequency": 0.9,
    "backchannel_words": [
      "yeah",
      "uh-huh"
    ],
    "vocab_specialization": "general",
    "allow_user_dtmf": true,
    "user_dtmf_options": {
      "digit_limit": 123,
      "timeout_ms": 123,
      "termination_key": "<string>"
    },
    "denoising_mode": "noise-cancellation",
    "reminder_trigger_ms": 10000,
    "reminder_max_count": 2,
    "ambient_sound": "coffee-shop",
    "ambient_sound_volume": 1,
    "language": "en-US",
    "boosted_keywords": [
      "aicall",
      "kroger"
    ],
    "normalize_for_speech": true,
    "end_call_after_silence_ms": 600000,
    "max_call_duration_ms": 3600000,
    "voicemail_option": {
      "action": {
        "type": "static_text",
        "text": "Please give us a callback tomorrow at 10am."
      }
    },
    "analysis_data": [
      {
        "type": "<string>",
        "name": "<string>",
        "description": "<string>",
        "examples": [
          "<string>"
        ]
      }
    ],
    "ring_duration_ms": 30000
  }
}

Authorizations

api_key

string

header

required

Headers

Company-Name

string

required

The name of the schema to be used for the request

Query Parameters

request_for

enum<string>

required

Specifies whether the request is for an agent or LLM

Available options:

agent,

llm

Example:

"agent"

number

required

Unique identifier for the AI call agent or LLM to be updated

Example:

12

Body

application/json

Configuration details to update for the AI call agent or LLM

Option 1
Option 2

agent

object

required

Show child attributes

agent.agent_name

string | null

The name of the agent, used for reference.

Example:

"Jarvis"

agent.voice_id

string

Unique voice ID used for the agent.

Example:

"11labs-Adrian"

agent.voice_temperature

number

Controls voice stability for ElevenLabs voices. Lower is more stable, higher is more variant. Defaults to 1.

Required range: 0 <= x <= 2

Example:

1

agent.voice_speed

number

Controls voice speed. Lower is slower, higher is faster. Defaults to 1.

Required range: 0.5 <= x <= 2

Example:

1

agent.volume

number

Controls agent volume. Lower is quieter, higher is louder. Defaults to 1.

Required range: 0 <= x <= 2

Example:

1

agent.responsiveness

number

Controls agent responsiveness. Lower is slower, higher is faster. Defaults to 1.

Required range: 0 <= x <= 1

Example:

1

agent.interruption_sensitivity

number

Controls sensitivity to user interruptions. Lower is harder to interrupt, higher is easier. Defaults to 1.

Required range: 0 <= x <= 1

Example:

1

agent.pronunciation_dictionary

object[] | null

A list of words/phrases and their pronunciation to guide audio synthesis. Currently only supported for English & 11labs voices. Set to null to remove.

Show child attributes

agent.pronunciation_dictionary.word

string

The string of word/phrase to be annotated with pronunciation.

Example:

"actually"

agent.pronunciation_dictionary.alphabet

enum<string>

The phonetic alphabet to be used for pronunciation.

Available options:

cmu,

ipa

agent.pronunciation_dictionary.phoneme

string

Pronunciation of the word in the format of IPA/CMU pronunciation.

Example:

"ˈæktʃuəli"

agent.enable_backchannel

boolean

Enables backchannel responses (e.g., 'yeah', 'uh-huh'). Defaults to false.

Example:

true

agent.backchannel_frequency

number

Controls backchannel frequency when enabled. Lower is less frequent, higher is more frequent. Defaults to 0.8.

Required range: 0 <= x <= 1

Example:

0.9

agent.backchannel_words

string[] | null

List of backchannel words. Defaults apply if not set.

Example:

["yeah", "uh-huh"]

agent.vocab_specialization

enum<string>

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

Available options:

general,

medical

Example:

"general"

agent.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

agent.user_dtmf_options

object

DTMF options for the agent.

Show child attributes

agent.user_dtmf_options.digit_limit

number

The maximum number of digits allowed in the user's DTMF input per turn.

agent.user_dtmf_options.timeout_ms

number

The time (in milliseconds) to wait for user DTMF input before timing out.

agent.user_dtmf_options.termination_key

string

A single key that signals the end of DTMF input (0–9, #, *).

agent.denoising_mode

enum<string>

Denoising mode for audio. Defaults to noise-cancellation.

Available options:

noise-cancellation,

noise-and-background-speech-cancellation

Example:

"noise-cancellation"

agent.reminder_trigger_ms

number

Triggers reminder after user silence duration (ms). Defaults to 10000.

Required range: x >= 0

Example:

10000

agent.reminder_max_count

integer

Maximum number of reminders for unresponsive user. Defaults to 1.

Required range: x >= 0

Example:

2

agent.ambient_sound

enum<string> | null

Ambient sound for realistic call experience. Set to null to remove.

Available options:

coffee-shop,

convention-hall,

summer-outdoor,

mountain-outdoor,

static-noise,

call-center

agent.ambient_sound_volume

number

Controls ambient sound volume. Lower is quieter, higher is louder. Defaults to 1.

Required range: 0 <= x <= 2

Example:

1

agent.language

enum<string>

Language and dialect for speech recognition. Defaults to en-US.

Available options:

en-US,

en-IN,

en-GB,

en-AU,

en-NZ,

de-DE,

es-ES,

es-419,

hi-IN,

fr-FR,

fr-CA,

ja-JP,

pt-PT,

pt-BR,

zh-CN,

ru-RU,

it-IT,

ko-KR,

nl-NL,

nl-BE,

pl-PL,

tr-TR,

th-TH,

vi-VN,

ro-RO,

bg-BG,

ca-ES,

da-DK,

fi-FI,

el-GR,

hu-HU,

id-ID,

no-NO,

sk-SK,

sv-SE,

multi

Example:

"en-US"

agent.boosted_keywords

string[] | null

Keywords to bias transcriber model. Set to null to remove.

Example:

["aicall", "kroger"]

agent.normalize_for_speech

boolean

Normalizes text to spoken form for consistent synthesis.

Example:

true

agent.end_call_after_silence_ms

integer

Ends call after user silence duration (ms). Defaults to 600000.

Required range: x >= 10000

Example:

600000

agent.max_call_duration_ms

integer

Maximum call duration (ms). Defaults to 3600000.

Required range: 60000 <= x <= 7200000

Example:

3600000

agent.voicemail_option

object

Voicemail detection settings. Set to null to disable.

Show child attributes

agent.voicemail_option.action

object

Show child attributes

agent.voicemail_option.action.type

string

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

Example:

"static_text"

agent.voicemail_option.action.text

string

Text for voicemail prompt, if applicable.

Example:

"Please give us a callback tomorrow at 10am."

agent.analysis_data

object[] | null

Additional data to extract post-call. Available after call ends.

Configuration for a single post-call analysis field.

Option 1
Option 2
Option 3
Option 4

Show child attributes

agent.analysis_data.type

string

required

The data type of the analysis field, set to string.

Allowed value: "string"

agent.analysis_data.name

string

required

The name of the analysis field.

agent.analysis_data.description

string

required

A description of what the analysis field represents.

agent.analysis_data.examples

string[] | null

Example values for the analysis field.

agent.ring_duration_ms

integer

Ring duration for calls (ms). Defaults to 30000.

Required range: 5000 <= x <= 90000

Example:

30000

Response

AI call agent or LLM update response

Option 1
Option 2

agent

object

required

Show child attributes

agent.agent_name

string | null

The name of the agent, used for reference.

Example:

"Jarvis"

agent.voice_id

string

Unique voice ID used for the agent.

Example:

"11labs-Adrian"

agent.voice_temperature

number

Controls voice stability for ElevenLabs voices. Lower is more stable, higher is more variant. Defaults to 1.

Required range: 0 <= x <= 2

Example:

1

agent.voice_speed

number

Controls voice speed. Lower is slower, higher is faster. Defaults to 1.

Required range: 0.5 <= x <= 2

Example:

1

agent.volume

number

Controls agent volume. Lower is quieter, higher is louder. Defaults to 1.

Required range: 0 <= x <= 2

Example:

1

agent.responsiveness

number

Controls agent responsiveness. Lower is slower, higher is faster. Defaults to 1.

Required range: 0 <= x <= 1

Example:

1

agent.interruption_sensitivity

number

Controls sensitivity to user interruptions. Lower is harder to interrupt, higher is easier. Defaults to 1.

Required range: 0 <= x <= 1

Example:

1

agent.pronunciation_dictionary

object[] | null

A list of words/phrases and their pronunciation to guide audio synthesis. Currently only supported for English & 11labs voices. Set to null to remove.

Show child attributes

agent.pronunciation_dictionary.word

string

The string of word/phrase to be annotated with pronunciation.

Example:

"actually"

agent.pronunciation_dictionary.alphabet

enum<string>

The phonetic alphabet to be used for pronunciation.

Available options:

cmu,

ipa

agent.pronunciation_dictionary.phoneme

string

Pronunciation of the word in the format of IPA/CMU pronunciation.

Example:

"ˈæktʃuəli"

agent.enable_backchannel

boolean

Enables backchannel responses (e.g., 'yeah', 'uh-huh'). Defaults to false.

Example:

true

agent.backchannel_frequency

number

Controls backchannel frequency when enabled. Lower is less frequent, higher is more frequent. Defaults to 0.8.

Required range: 0 <= x <= 1

Example:

0.9

agent.backchannel_words

string[] | null

List of backchannel words. Defaults apply if not set.

Example:

["yeah", "uh-huh"]

agent.vocab_specialization

enum<string>

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

Available options:

general,

medical

Example:

"general"

agent.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

agent.user_dtmf_options

object

DTMF options for the agent.

Show child attributes

agent.user_dtmf_options.digit_limit

number

The maximum number of digits allowed in the user's DTMF input per turn.

agent.user_dtmf_options.timeout_ms

number

The time (in milliseconds) to wait for user DTMF input before timing out.

agent.user_dtmf_options.termination_key

string

A single key that signals the end of DTMF input (0–9, #, *).

agent.denoising_mode

enum<string>

Denoising mode for audio. Defaults to noise-cancellation.

Available options:

noise-cancellation,

noise-and-background-speech-cancellation

Example:

"noise-cancellation"

agent.reminder_trigger_ms

number

Triggers reminder after user silence duration (ms). Defaults to 10000.

Required range: x >= 0

Example:

10000

agent.reminder_max_count

integer

Maximum number of reminders for unresponsive user. Defaults to 1.

Required range: x >= 0

Example:

2

agent.ambient_sound

enum<string> | null

Ambient sound for realistic call experience. Set to null to remove.

Available options:

coffee-shop,

convention-hall,

summer-outdoor,

mountain-outdoor,

static-noise,

call-center

agent.ambient_sound_volume

number

Controls ambient sound volume. Lower is quieter, higher is louder. Defaults to 1.

Required range: 0 <= x <= 2

Example:

1

agent.language

enum<string>

Language and dialect for speech recognition. Defaults to en-US.

Available options:

en-US,

en-IN,

en-GB,

en-AU,

en-NZ,

de-DE,

es-ES,

es-419,

hi-IN,

fr-FR,

fr-CA,

ja-JP,

pt-PT,

pt-BR,

zh-CN,

ru-RU,

it-IT,

ko-KR,

nl-NL,

nl-BE,

pl-PL,

tr-TR,

th-TH,

vi-VN,

ro-RO,

bg-BG,

ca-ES,

da-DK,

fi-FI,

el-GR,

hu-HU,

id-ID,

no-NO,

sk-SK,

sv-SE,

multi

Example:

"en-US"

agent.boosted_keywords

string[] | null

Keywords to bias transcriber model. Set to null to remove.

Example:

["aicall", "kroger"]

agent.normalize_for_speech

boolean

Normalizes text to spoken form for consistent synthesis.

Example:

true

agent.end_call_after_silence_ms

integer

Ends call after user silence duration (ms). Defaults to 600000.

Required range: x >= 10000

Example:

600000

agent.max_call_duration_ms

integer

Maximum call duration (ms). Defaults to 3600000.

Required range: 60000 <= x <= 7200000

Example:

3600000

agent.voicemail_option

object

Voicemail detection settings. Set to null to disable.

Show child attributes

agent.voicemail_option.action

object

Show child attributes

agent.voicemail_option.action.type

string

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

Example:

"static_text"

agent.voicemail_option.action.text

string

Text for voicemail prompt, if applicable.

Example:

"Please give us a callback tomorrow at 10am."

agent.analysis_data

object[] | null

Additional data to extract post-call. Available after call ends.

Configuration for a single post-call analysis field.

Option 1
Option 2
Option 3
Option 4

Show child attributes

agent.analysis_data.type

string

required

The data type of the analysis field, set to string.

Allowed value: "string"

agent.analysis_data.name

string

required

The name of the analysis field.

agent.analysis_data.description

string

required

A description of what the analysis field represents.

agent.analysis_data.examples

string[] | null

Example values for the analysis field.

agent.ring_duration_ms

integer

Ring duration for calls (ms). Defaults to 30000.

Required range: 5000 <= x <= 90000

Example:

30000

Get LLM Delete Agent

⌘I

API Documentation

Authentication

Dashboard Data

Agent

Campaign

Callbacks

Contact

Phone Number

Integrations

Billing & Subscription

Credits

Authorizations

Headers

Query Parameters

Body

Response