# Get agent (/docs/api-reference/agents/getAgent) > Get details of a specific agent by ID. **GET** `/agents/{agent_id}` Get details of a specific agent by ID. ```yaml operationId: getAgent responses: '200': description: Agent details. content: application/json: schema: type: object description: An AI voice agent. properties: id: type: integer example: 158910 name: type: string example: Customer Support Agent bot_type: type: string example: prompt bot_call_type: type: string enum: - Incoming - Outgoing user_id: type: integer user_name: type: string organization_id: type: integer welcome_message: type: string is_welcome_message_dynamic: type: boolean is_welcome_message_interruption: type: boolean is_interruption_allowed: type: boolean interruption_min_words: type: integer status_of_building_flow: type: string example: Completed context_breakdown: type: array items: type: object properties: id: type: integer context_title: type: string context_body: type: string is_enabled: type: boolean is_auto_generated: type: boolean languages: type: array description: Resolved language records. Each entry is `{value, label}` from `bot.language`. items: type: object properties: value: type: integer label: type: string llm_service: type: string example: gpt-4o-mini llm_temperature: type: number llm_straming_enabled: type: boolean asr_service: type: string example: deepgram_stream asr_deepgram_model: type: string asr_deepgram_numerals: type: boolean asr_deepgram_punctuate: type: boolean asr_deepgram_smart_format: type: boolean asr_deepgram_diarize: type: boolean silence_timeout: type: integer voice_provider: type: string voice_external_id: type: string description: External voice ID from the provider. voice_name: type: string english_voice_accent: type: string eleven_lab_voice_public_owner_id: type: string nullable: true speech_speed: type: number enable_web_search: type: boolean web_search_engine: type: string background_noise_enabled: type: boolean background_noice_name: oneOf: - type: string - type: boolean background_audio_volume: type: number initial_ringing_sound_enabled: type: boolean voicemail_enabled: type: boolean voicemail_message: type: string is_end_call_enabled: type: boolean end_call_condition: type: string end_call_message: type: string end_call_message_type: type: string end_call_message_prompt: type: string max_call_duration_in_sec: type: integer user_idle_threshold_sec: type: integer first_ideal_message: type: string second_ideal_message: type: string last_ideal_message: type: string is_first_ideal_message_dynamic: type: boolean is_second_ideal_message_dynamic: type: boolean is_transfer_enabled: type: boolean is_custom_api_transfer_enabled: type: boolean transfer_options: type: array items: type: object properties: number: type: string type: type: string enum: - static - dynamic backup_numbers: type: array items: type: string transfer_condition: type: string transfer_message: type: string post_call_config_ids: type: array description: Resolved post-call notification configs. One entry per email/webhook destination. items: type: object properties: id: type: integer delivery_method: type: string enum: - Email - Webhook destination: type: string description: Comma-separated recipients for Email; webhook url for Webhook. include_summary: type: boolean include_full_conversation: type: boolean include_sentiment: type: boolean include_extracted_info: type: boolean extracted_variables: type: array items: type: object properties: key: type: string description: type: string attach_file_ids: type: array description: IDs of knowledge-base files attached to this agent. items: type: integer integrations: type: array description: Connected integration records (HubSpot, Salesforce, Slack, etc.). items: type: object flow_data: oneOf: - type: object - type: boolean bot_action_name: oneOf: - type: string - type: boolean example: id: 6342 organization_id: 14 name: Outbound Real Estate Lead Qualification Agent context: > # Agent Identity & Purpose # AGENT GLOBAL INSTRUCTIONS ## PERSONA - The agent is a virtual real estate sales assistant. - Represents a real estate company calling a potential property buyer or renter. - Speaks directly to the lead (customer). - Purpose is to confirm interest, qualify the lead, and follow up on previous inquiries. - Overall intent is to be polite, friendly, and professional, with a calm and helpful demeanor. # RESPONSE GENERATION GUIDES - Your responses will be read aloud by a text-to-speech system. - Always use short, simple, conversational sentences. - Never use bullet points, numbered lists, formatted text, or symbols in spoken responses. - End responses with a soft, natural conversational hook when appropriate. - Speak politely and naturally, as if talking to a real person on a phone call. # SCOPE - Can introduce the company and reason for calling. - Can confirm the lead’s interest in buying, selling, or renting property. - Can ask qualifying questions about property needs, budget, and timeline. - Can schedule a follow-up call or appointment with a real estate agent. - Cannot provide legal, financial, or technical advice. - Must politely redirect unsupported queries. # GUARDRAILS - Never pressure, manipulate, or rush the lead. - Never guarantee property availability, pricing, or approval. - Never ask for sensitive information such as social security numbers or full bank details. # Lead Confirmation & Introduction # LEAD CONFIRMATION & INTRODUCTION - Confirm the lead’s name and introduce the company. - State the purpose of the call and reference the lead’s previous inquiry if applicable. Example response: Hello [user_name], this is [agent_name] from [company_name]. I am calling because you showed interest in our real estate listings. Is now a good time to talk? # Interest & Needs Qualification # INTEREST & NEEDS QUALIFICATION - Ask if the lead is still interested in buying, selling, or renting property. - Ask simple qualifying questions about property type, location, budget, and timeline. Example response: Are you still interested in finding a new property? What kind of home or apartment are you looking for? # Follow-Up & Appointment Scheduling # FOLLOW-UP & APPOINTMENT SCHEDULING - Offer to schedule a call or meeting with a licensed real estate agent if the lead is interested. - Confirm preferred times and contact details. Example response: Would you like to schedule a call with one of our real estate agents to discuss your options in more detail? What time works best for you? # Handle Not Interested or Unavailable # HANDLE NOT INTERESTED OR UNAVAILABLE - Respect the lead’s decision if they are not interested or unavailable. - Offer to follow up later if appropriate. - Close politely. Example response: That is completely fine. Thank you for your time. If you change your mind, feel free to contact us anytime. # Closing Statement # CLOSING STATEMENT - End the call politely and thank the lead for their time. Example response: Thank you for speaking with me today. Have a wonderful day. # Agent Knowledge & Context The agent understands real estate lead qualification, polite follow-up etiquette, and how to schedule appointments with licensed agents. The agent is aware of the importance of privacy and never asks for sensitive information. # FAQ Examples User: How did you get my number? Agent: You shared your contact details with us when you showed interest in our real estate listings. User: Can you send me more property details? Agent: I can arrange for a real estate agent to send you more information or schedule a call to discuss your needs. User: Are you a real person? Agent: I am a virtual assistant calling on behalf of [company_name] to help with your real estate inquiry. user_id: 1234 user_name: Demo User bot_action_id: false context_breakdown: - id: 114705 context_title: Agent Identity & Purpose context_body: >- # AGENT GLOBAL INSTRUCTIONS ## PERSONA - The agent is a virtual real estate sales assistant. - Represents a real estate company calling a potential property buyer or renter. - Speaks directly to the lead (customer). - Purpose is to confirm interest, qualify the lead, and follow up on previous inquiries. - Overall intent is to be polite, friendly, and professional, with a calm and helpful demeanor. # RESPONSE GENERATION GUIDES - Your responses will be read aloud by a text-to-speech system. - Always use short, simple, conversational sentences. - Never use bullet points, numbered lists, formatted text, or symbols in spoken responses. - End responses with a soft, natural conversational hook when appropriate. - Speak politely and naturally, as if talking to a real person on a phone call. # SCOPE - Can introduce the company and reason for calling. - Can confirm the lead’s interest in buying, selling, or renting property. - Can ask qualifying questions about property needs, budget, and timeline. - Can schedule a follow-up call or appointment with a real estate agent. - Cannot provide legal, financial, or technical advice. - Must politely redirect unsupported queries. # GUARDRAILS - Never pressure, manipulate, or rush the lead. - Never guarantee property availability, pricing, or approval. - Never ask for sensitive information such as social security numbers or full bank details. is_enabled: true is_auto_generated: false - id: 114706 context_title: Lead Confirmation & Introduction context_body: >- # LEAD CONFIRMATION & INTRODUCTION - Confirm the lead’s name and introduce the company. - State the purpose of the call and reference the lead’s previous inquiry if applicable. Example response: Hello [user_name], this is [agent_name] from [company_name]. I am calling because you showed interest in our real estate listings. Is now a good time to talk? is_enabled: true is_auto_generated: false - id: 114707 context_title: Interest & Needs Qualification context_body: >- # INTEREST & NEEDS QUALIFICATION - Ask if the lead is still interested in buying, selling, or renting property. - Ask simple qualifying questions about property type, location, budget, and timeline. Example response: Are you still interested in finding a new property? What kind of home or apartment are you looking for? is_enabled: true is_auto_generated: false - id: 114708 context_title: Follow-Up & Appointment Scheduling context_body: >- # FOLLOW-UP & APPOINTMENT SCHEDULING - Offer to schedule a call or meeting with a licensed real estate agent if the lead is interested. - Confirm preferred times and contact details. Example response: Would you like to schedule a call with one of our real estate agents to discuss your options in more detail? What time works best for you? is_enabled: true is_auto_generated: false - id: 114709 context_title: Handle Not Interested or Unavailable context_body: >- # HANDLE NOT INTERESTED OR UNAVAILABLE - Respect the lead’s decision if they are not interested or unavailable. - Offer to follow up later if appropriate. - Close politely. Example response: That is completely fine. Thank you for your time. If you change your mind, feel free to contact us anytime. is_enabled: true is_auto_generated: false - id: 114710 context_title: Closing Statement context_body: |- # CLOSING STATEMENT - End the call politely and thank the lead for their time. Example response: Thank you for speaking with me today. Have a wonderful day. is_enabled: true is_auto_generated: false - id: 114711 context_title: Agent Knowledge & Context context_body: >- The agent understands real estate lead qualification, polite follow-up etiquette, and how to schedule appointments with licensed agents. The agent is aware of the importance of privacy and never asks for sensitive information. is_enabled: true is_auto_generated: false - id: 114712 context_title: FAQ Examples context_body: >- User: How did you get my number? Agent: You shared your contact details with us when you showed interest in our real estate listings. User: Can you send me more property details? Agent: I can arrange for a real estate agent to send you more information or schedule a call to discuss your needs. User: Are you a real person? Agent: I am a virtual assistant calling on behalf of [company_name] to help with your real estate inquiry. is_enabled: true is_auto_generated: false llm_service: gpt-4.1-mini asr_service: deepgram_stream llm_straming_enabled: true voice: 8 voice_provider: deepgram voice_external_id: aura-asteria-en eleven_lab_voice_public_owner_id: false english_voice_accent: en-IN voice_name: asteria languages: - value: 1 label: English welcome_message: Hello, I am [agent_name] from [company_name]. Am I speaking with [user_name]? is_welcome_message_dynamic: true is_welcome_message_interruption: false is_interruption_allowed: true bot_type: prompt flow_data: false status_of_building_flow: Completed bot_call_type: Outgoing attach_file_ids: [] attach_file_access_description: false integration_ids: [] integrations: [] enable_web_search: false web_search_engine: false post_call_config_ids: - id: 13208 delivery_method: false destination: demo@example.com include_summary: true include_full_conversation: true include_sentiment: true include_extracted_info: true extracted_variables: - key: user_name description: Name of the lead being called - key: agent_name description: Name of the virtual agent - key: company_name description: Name of the real estate company slack_integration_id: false slack_channel_name: false slack_channel_id: false salesforce_integration_id: false salesforce_object_name: false hubspot_integration_id: false hubspot_object_name: false webhook_url: false payload_transformation_type: none payload_transformation_template: false strip_country_code: false google_sheets_integration_id: false google_sheets_spreadsheet_id: false google_sheets_spreadsheet_name: false google_sheets_worksheet_name: Sheet1 whatsapp_integration_id: false whatsapp_template_sid: false cloud_whatsapp_phone_number_id: false cloud_whatsapp_template_id: false cloud_whatsapp_template_variables: [] cloud_whatsapp_templates: [] workflow_id: false trigger_call_statuses: - completed - voicemail_detected silence_timeout: 200 speech_speed: 1 speech_start_timeout: 150 speech_start_timeout_when_bot_speaking: 350 min_speech_duration_ms: 300 vad_confidence_threshold_when_listening: 0.6 vad_confidence_threshold_when_bot_speaking: 0.6 min_speech_duration_ms_speaking: 300 should_apply_noise_reduction: true interruption_min_words: 2 max_call_duration_in_sec: 600 user_idle_threshold_sec: 10 first_ideal_message: Are you still there? is_first_ideal_message_dynamic: true second_ideal_message: Would you like to continue our conversation? is_second_ideal_message_dynamic: true last_ideal_message: I'll leave you for now. Have a nice day! asr_deepgram_language: en asr_cartesia_language: en asr_azure_language: en-IN asr_cartesia_model: ink-whisper tts_cartesia_model_id: ink-whisper asr_sarvam_language: unknown asr_soniox_language: false asr_sarvam_model: saaras:v3 asr_deepgram_model: nova-3 asr_deepgram_numerals: true asr_deepgram_punctuate: true asr_deepgram_smart_format: true asr_deepgram_diarize: false llm_temperature: 0.7 secret_key: b83af708003e600335dc8c1d6862bf79 widget_config: title: OmniDimension Agent logoUrl: https://www.omnidim.io/logo.png position: bottom-right iframeUrl: http://localhost:3000/chat-widget?secret=b83af708003e600335dc8c1d6862bf79 textColor: '#b1fbf8' background: '#142744' widgetType: chat iframeWidth: 350px iframeHeight: 550px voiceWidgetStyle: full dynamic_variables: [] is_transfer_enabled: false is_custom_api_transfer_enabled: false transfer_options: [] is_end_call_enabled: true end_call_condition: >- End the call when the user says goodbye, thank you, or indicates they are done with the conversation end_call_message: Thank you for calling. Have a great day! Goodbye. end_call_message_type: prompt end_call_message_prompt: End the call politely in the same language user is speaking voicemail_enabled: false voicemail_message: false call_cost_per_min: 0.09 background_noice_name: false background_audio_volume: 0.2 background_noise_enabled: false initial_ringing_sound_enabled: false ``` **Python SDK** ```python from omnidimension import Client client = Client(api_key) # Get details of a specific agent agent_id = "your_agent_id_here" response = client.agent.get(agent_id) print(response) ``` **curl** ```bash curl -X GET "https://backend.omnidim.io/api/v1/agents/{agent_id}" \ -H "Authorization: Bearer $OMNIDIM_API_KEY" ```