> ## Documentation Index > Fetch the complete documentation index at: https://docs.closerx.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Agent > Retrieves the configuration of an existing AI call agent by its ID ## OpenAPI ````yaml GET /agent/update/{agent_id}/ openapi: 3.1.0 info: title: CloserX.ai API description: >- The CloserX.ai API provides programmatic access to manage AI-powered calling operations, including agent creation, campaign management, contact handling, telephony integration, and more. This API enables seamless automation and integration with CRM systems, telephony providers, and other third-party services for enhanced client communication and business operations. license: name: MIT version: 1.0.0 servers: - url: https://app.closerx.ai/api security: - api_key: [] paths: /agent/update/{agent_id}/: get: description: Retrieves the configuration of an existing AI call agent by its ID parameters: - name: Company-Name in: header description: The name of the schema to be used for the request required: true schema: type: string - name: agent_id in: path description: Unique identifier for the AI call agent to retrieve required: true schema: type: string example: 16b980523634a6dc504898cda492e939 responses: '200': description: AI call agent retrieval response content: application/json: schema: $ref: '#/components/schemas/UpdateAgentResponse' '400': description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: UpdateAgentResponse: type: object required: - success - message - data - voice_list - ghl_data properties: success: type: boolean description: Indicates whether the request was successful example: true message: type: string description: Message describing the result of the request example: get agent detail data: type: object required: - pk - agent_name - agent_id - voice_id - language - interruption_sensitivity - voicemail - voicemail_message - end_call_after_silence - max_call_duration - reminder_trigger - ambient_sound - analysis_data - llm - voice_speed - voice_temperature - volume - enable_backchannel - normalize_for_speech - enable_transcription_formatting - reminder_trigger_ms - reminder_max_count - boosted_keywords - ambient_sound_volume - voicemail_detection_timeout_ms - begin_message_delay_ms - updated_at - is_locked - calendar_id - inbound_appoitment - ring_duration_sec - stt_mode - backchannel_words - backchannel_frequency - call_scheduling - agent_crm_type - voicemail_option properties: pk: type: integer description: Primary key for the AI call agent example: 521 agent_name: type: string description: Name of the AI call agent example: add_agent_name agent_id: type: string description: Unique identifier for the AI call agent example: agent_aa2c4c2895abe6ab7c0e89b607 voice_id: type: string description: Identifier for the voice used by the agent example: 11labs-Marissa language: type: string description: Language code or type (e.g., en-US, multi) example: en-US interruption_sensitivity: type: string description: Sensitivity level for interruptions example: '1.0' pronunciation_dictionary: type: array items: type: object properties: word: type: string description: '' example: hello alphabet: type: string description: '' enum: - CMU - IPA phoneme: type: string description: '' description: >- List of words/phrases with pronunciations for consistent synthesis. Set to null to remove. nullable: true vocab_specialization: type: string enum: - general - medical description: >- Vocabulary set for transcription (English only). Defaults to general. example: general allow_user_dtmf: type: boolean description: >- If set to true, DTMF input will be accepted and processed. If false, any DTMF input will be ignored. Default to true. example: true user_dtmf_options: type: object description: DTMF options for the agent. properties: digit_limit: type: number description: >- 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. timeout_ms: type: number description: >- The time (in milliseconds) to wait for user DTMF input before timing out. The timer resets with each digit received. termination_key: type: string description: >- A single key that signals the end of DTMF input. Acceptable values include any digit (0–9), the pound/hash symbol (#), or the asterisk (*). nullable: true denoising_mode: type: string enum: - noise-cancellation - noise-and-background-speech-cancellation description: Denoising mode for audio. Defaults to noise-cancellation. example: noise-cancellation voicemail: type: boolean description: Indicates if voicemail is enabled example: true voicemail_message: type: string description: Voicemail message content nullable: true example: null end_call_after_silence: type: integer description: Duration of silence before ending the call (in seconds) example: 10 max_call_duration: type: integer description: Maximum call duration (in minutes) example: 10 reminder_trigger: type: integer description: Time before triggering a reminder (in seconds) example: 10 ambient_sound: type: string description: Ambient sound setting nullable: true example: null analysis_data: type: array description: Data for call analysis items: type: string example: [] llm: type: integer description: Identifier for the language model used example: 527 voice_speed: type: number format: float description: Speed of the voice example: 1 voice_temperature: type: number format: float description: Temperature setting for voice generation example: 1 volume: type: number format: float description: Volume level for the voice example: 1 enable_backchannel: type: boolean description: Indicates if backchannel responses are enabled example: true normalize_for_speech: type: boolean description: Indicates if speech normalization is enabled example: false enable_transcription_formatting: type: boolean description: Indicates if transcription formatting is enabled example: true reminder_trigger_ms: type: integer description: Reminder trigger time in milliseconds example: 10000 reminder_max_count: type: integer description: Maximum number of reminders example: 1 boosted_keywords: type: array description: List of keywords to boost in processing items: type: string example: [] ambient_sound_volume: type: number format: float description: Volume level for ambient sound example: 1 voicemail_detection_timeout_ms: type: integer description: Timeout for voicemail detection in milliseconds example: 5000 begin_message_delay_ms: type: integer description: Delay before starting message in milliseconds example: 0 updated_at: type: string format: date-time description: Timestamp when the agent was last updated example: '2025-08-13T09:41:44.564571Z' is_locked: type: boolean description: Indicates if the agent is locked example: false calendar_id: type: string description: Identifier for associated calendar nullable: true example: null inbound_appoitment: type: boolean description: Indicates if inbound appointment scheduling is enabled example: false ring_duration_sec: type: integer description: Ring duration in seconds example: 30 stt_mode: type: string description: Speech-to-text mode (e.g., fast) example: fast backchannel_words: type: string description: Words used for backchannel responses nullable: true example: null backchannel_frequency: type: number format: float description: Frequency of backchannel responses example: 0.8 call_scheduling: type: boolean description: Indicates if call scheduling is enabled example: false agent_crm_type: type: string description: Type of CRM integration for the agent nullable: true example: null voicemail_option: type: object description: Voicemail options for the agent properties: action: type: object properties: type: type: string description: Type of voicemail action (e.g., hangup) example: hangup voice_list: type: array description: List of available voices for the agent items: type: object required: - id - voice_name - voice_id - avatar_url - preview_audio_url - created_at - updated_at properties: id: type: integer description: Unique identifier for the voice example: 3 voice_name: type: string description: Name of the voice example: aicall_ryan voice_id: type: string description: Unique identifier for the voice example: custom_voice_937c75901acb54b42837d3dafa preview_audio_url: type: string format: uri description: URL to the voice's preview audio example: >- https://aicall-utils-public.s3.us-west-2.amazonaws.com/custom_voice_937c75901acb54b42837d3dafa.mp3 created_at: type: string format: date-time description: Timestamp when the voice was created example: '2025-08-01T16:31:51.688674Z' updated_at: type: string format: date-time description: Timestamp when the voice was last updated example: '2025-08-01T16:31:51.688683Z' ghl_data: type: object required: - ghl_connection - ghl_book_meeting - inbound_appoitment - calendar_id properties: ghl_connection: type: boolean description: Indicates if GoHighLevel is connected example: true ghl_book_meeting: type: boolean description: Indicates if meeting booking is enabled example: true inbound_appoitment: type: boolean description: Indicates if inbound appointment scheduling is enabled example: false calendar_id: type: string description: Identifier for associated calendar nullable: true example: null Error: required: - success - message - data type: object properties: success: type: boolean message: type: string data: type: object securitySchemes: api_key: type: apiKey in: header name: api_key ````