> ## Documentation Index
> Fetch the complete documentation index at: https://voice.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Agent Details

> Get detailed information on a single agent.



## OpenAPI

````yaml /docs/openapi.json get /api/v1/agent/{agent_id}
openapi: 3.1.0
info:
  title: Voice AI Developer API
  description: >-
    Generate realistic speech and clone voices. AI voice agents with retrieval
    augmented generation (RAG) and model context protocol (MCP) included.
  version: 1.5.0
  contact: {}
servers:
  - url: https://dev.voice.ai
    description: HTTP API endpoints
security:
  - BearerAuth: []
tags:
  - name: Text To Speech
    description: Text-to-speech endpoints for voice cloning and speech generation.
  - name: Pronunciation Dictionaries
    description: Manage versioned pronunciation dictionaries for TTS and voice agents.
  - name: Agent Management
    description: Create, update, deploy, and manage voice agents.
  - name: Models
    description: Discover supported LLM and TTS model options.
  - name: Agent Connection
    description: Connect to agents and manage active calls.
  - name: Agent Analytics
    description: >-
      Analytics and reporting for agent performance, call history, and
      statistics.
  - name: Agent Knowledge Base
    description: >-
      Manage knowledge bases for retrieval augmented generation (RAG) with your
      agents.
  - name: Phone Number Management
    description: >-
      Search, select, and manage phone numbers from your plan allocation.
      Release numbers to free up slots.
  - name: Managed Tools
    description: >-
      Connect Google Calendar, Sheets, and Gmail to agents and inspect
      connection state.
paths:
  /api/v1/agent/{agent_id}:
    get:
      tags:
        - Agent Management
      summary: Get Agent Details
      description: Get detailed information on a single agent.
      operationId: get_specific_agent_api_v1_agent__agent_id__get
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: string
            title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Agent:
      properties:
        agent_id:
          type: string
          title: Agent Id
        name:
          type: string
          title: Name
        config:
          $ref: '#/components/schemas/AgentConfig'
          title: Config
        status:
          type: string
          title: Status
          default: paused
        status_code:
          type: integer
          title: Status Code
          default: 1
        kb_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Kb Id
          nullable: true
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - agent_id
        - name
        - config
        - created_at
        - updated_at
      title: Agent
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentConfig:
      properties:
        prompt:
          type: string
          title: Prompt
          description: System prompt for the agent
        greeting:
          type: string
          title: Greeting
          description: Initial greeting message
        llm_temperature:
          type: number
          title: LLM Temperature
          description: LLM sampling temperature (0.0-2.0)
          default: 0.7
          minimum: 0
          maximum: 2
        llm_model:
          type: string
          title: LLM Model
          description: LLM model to use
          default: gemini-2.5-flash-lite
        tts_min_sentence_len:
          type: integer
          title: TTS Min Sentence Length
          description: Minimum characters before TTS starts
          default: 20
        tts_params:
          $ref: '#/components/schemas/TTSParams'
          description: TTS voice and model configuration
        min_silence_duration:
          type: number
          title: Min Silence Duration
          description: Seconds of silence before end-of-turn
          default: 0.55
        min_speech_duration:
          type: number
          title: Min Speech Duration
          description: Minimum speech duration to register
          default: 0.1
        user_silence_timeout:
          type: number
          title: User Silence Timeout
          description: Seconds before prompting silent user
          default: 10
        max_call_duration_seconds:
          type: number
          title: Max Call Duration
          description: Maximum call duration in seconds
          default: 900
        allow_interruptions:
          type: boolean
          title: Allow Interruptions
          description: Whether user can interrupt agent speech
          default: true
        allow_interruptions_on_greeting:
          type: boolean
          title: Allow Interruptions On Greeting
          description: Allow interruptions during greeting
          default: false
        min_interruption_words:
          type: integer
          title: Min Interruption Words
          description: Minimum words to trigger interruption (0=any)
          default: 1
          minimum: 0
          maximum: 10
        auto_noise_reduction:
          type: boolean
          title: Auto Noise Reduction
          description: Enable automatic noise reduction
          default: true
        allow_agent_to_end_call:
          type: boolean
          title: Allow Agent To End Call
          description: Whether agent can end calls
          default: false
        allow_agent_to_skip_turn:
          type: boolean
          title: Allow Agent To Skip Turn
          description: Whether agent can skip turns
          default: false
        min_endpointing_delay:
          type: number
          title: Min Endpointing Delay
          description: Minimum delay before end-of-turn detection
          default: 0.5
        max_endpointing_delay:
          type: number
          title: Max Endpointing Delay
          description: Maximum delay for end-of-turn detection
          default: 3
        vad_activation_threshold:
          type: number
          title: VAD Activation Threshold
          description: Voice activity detection sensitivity (0.0-1.0)
          default: 0.6
          minimum: 0
          maximum: 1
        phone_number:
          type: string
          title: Phone Number
          description: Phone number in E.164 format (e.g., +15551234567)
        phone_provider:
          type: string
          title: Phone Provider
          description: 'Phone number provider: ''twilio'' or ''telnyx'''
          default: twilio
          enum:
            - twilio
            - telnyx
        recording_enabled:
          type: boolean
          title: Recording Enabled
          description: Whether call recording is enabled.
          default: true
        webhooks:
          $ref: '#/components/schemas/WebhooksConfig'
          description: >-
            Webhook configuration for external callbacks, including event
            notifications, inbound call personalization, and callable tools.
        mcp_servers:
          type: array
          items:
            $ref: '#/components/schemas/MCPServerConfig'
          title: MCP Servers
          description: MCP servers configuration
      type: object
      title: AgentConfig
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    TTSParams:
      properties:
        voice_id:
          type: string
          title: Voice Id
          description: Voice ID to use for TTS
        model:
          type: string
          title: Model
          description: TTS model. Auto-selected based on language if not provided.
          enum:
            - voiceai-tts-v1-latest
            - voiceai-tts-v1-2026-02-10
            - voiceai-tts-multilingual-v1-latest
            - voiceai-tts-multilingual-v1-2026-02-10
        language:
          type: string
          title: Language
          description: Language code (ISO 639-1) or 'auto' for ASR detection
          default: en
          enum:
            - auto
            - en
            - ca
            - sv
            - es
            - fr
            - de
            - it
            - pt
            - pl
            - ru
            - nl
        temperature:
          type: number
          title: Temperature
          description: Sampling temperature (0.0-2.0)
          default: 1
          minimum: 0
          maximum: 2
        top_p:
          type: number
          title: Top P
          description: Nucleus sampling (0.0-1.0)
          default: 0.8
          minimum: 0
          maximum: 1
        dictionary_id:
          type: string
          title: Dictionary Id
          description: >-
            Dictionary identifier for TTS runtime pass-through (e.g., custom
            pronunciation).
      type: object
      title: TTSParams
    WebhooksConfig:
      description: >-
        Webhook configuration used by both requests and responses. Request-only
        credential fields are marked write-only and response-only indicators are
        marked read-only. `events` is a fan-out array; omit it to preserve, set
        it to null to clear, or pass a full array to replace.
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventsConfig'
          description: Event notification webhook configurations (fan-out list)
        tools:
          type: array
          items:
            $ref: '#/components/schemas/WebhookTool'
          title: Tools
          description: Webhook tool configuration array for callable functions
        inbound_call:
          $ref: '#/components/schemas/WebhookInboundCallConfig'
          description: Inbound call personalization webhook configuration
      type: object
      title: WebhooksConfig
    MCPServerConfig:
      properties:
        name:
          type: string
          title: Name
          description: Human-readable name for the server (required)
        description:
          type: string
          title: Description
          description: Description of the server's purpose or tools
        url:
          type: string
          title: URL
          description: >-
            MCP server endpoint URL. URLs ending with '/mcp' use streamable HTTP
            transport.
          format: uri
        auth_type:
          type: string
          enum:
            - none
            - bearer_token
            - api_key
            - custom_headers
          title: Auth Type
          description: Authentication type
          default: none
        auth_token:
          type: string
          title: Auth Token
          description: Token for bearer_token or api_key authentication
        headers:
          additionalProperties:
            type: string
          type: object
          title: Headers
          description: Custom HTTP headers
      type: object
      required:
        - name
        - url
      title: MCPServerConfig
    WebhookEventsConfig:
      description: >-
        Event webhook configuration used for both requests and responses.
        `secret` is accepted on input and omitted from response payloads;
        `has_secret` is response-only.
      properties:
        url:
          type: string
          title: URL
          description: Webhook endpoint URL
        secret:
          type: string
          title: Secret
          description: >-
            HMAC-SHA256 signing secret for payload verification. When replacing
            webhooks.events, omitted secrets are preserved only for entries
            whose url exactly matches an existing endpoint; secret: null clears
            it.
          nullable: true
          writeOnly: true
        has_secret:
          type: boolean
          title: Has Secret
          description: Whether a signing secret is configured
          default: false
          readOnly: true
        events:
          type: array
          items:
            type: string
          title: Events
          description: >-
            Event types to receive. Empty array = all events. Options:
            'call.started', 'call.completed', 'call.failed'.
        timeout:
          type: integer
          title: Timeout
          description: Request timeout in seconds
          default: 5
          minimum: 1
          maximum: 30
        enabled:
          type: boolean
          title: Enabled
          description: Whether webhook notifications are active
          default: true
      required:
        - url
      type: object
      title: WebhookEventsConfig
    WebhookTool:
      description: >-
        Webhook tool configuration used by both requests and responses.
        Credential fields are write-only and omitted from response payloads.
      properties:
        name:
          type: string
          title: Name
          description: Function name (e.g., 'lookup_customer')
        description:
          type: string
          title: Description
          description: When to use this tool
        url:
          type: string
          title: URL
          description: Webhook URL
        parameters:
          type: object
          title: Parameters
          description: Input fields - supports nested objects and arrays
          additionalProperties: true
        method:
          type: string
          enum:
            - GET
            - POST
            - PUT
            - PATCH
            - DELETE
          title: Method
          description: >-
            HTTP method for outbound API call. GET sends arguments as query
            params; POST/PUT/PATCH/DELETE send JSON body.
        execution_mode:
          type: string
          enum:
            - sync
            - async
          title: Execution Mode
          description: >-
            Execution mode: sync waits for downstream payload, async accepts any
            2xx.
        auth_type:
          type: string
          enum:
            - none
            - bearer_token
            - api_key
            - custom_headers
          title: Auth Type
          description: Authentication strategy for outbound API call
        auth_token:
          type: string
          title: Auth Token
          description: Token for bearer_token or api_key auth
          nullable: true
          writeOnly: true
        headers:
          type: object
          additionalProperties:
            type: string
          title: Headers
          description: >-
            Additional outbound HTTP headers for custom_headers or metadata
            passthrough
          nullable: true
          writeOnly: true
        response:
          type: object
          title: Response
          description: Expected response shape from the tool endpoint
          additionalProperties: true
          nullable: true
        timeout:
          type: integer
          title: Timeout
          description: Request timeout in seconds
          default: 10
          minimum: 1
          maximum: 120
      required:
        - name
        - description
        - url
        - parameters
        - method
        - execution_mode
        - auth_type
      type: object
      title: WebhookTool
    WebhookInboundCallConfig:
      description: >-
        Inbound call personalization webhook configuration used by both requests
        and responses. `secret` is accepted on input and omitted from response
        payloads; `has_secret` is response-only.
      properties:
        url:
          type: string
          title: URL
          description: Webhook endpoint URL
        secret:
          type: string
          title: Secret
          description: HMAC-SHA256 signing secret for payload verification
          nullable: true
          writeOnly: true
        has_secret:
          type: boolean
          title: Has Secret
          description: Whether a signing secret is configured
          default: false
          readOnly: true
        timeout:
          type: integer
          title: Timeout
          description: Request timeout in seconds
          default: 5
          minimum: 1
          maximum: 30
        enabled:
          type: boolean
          title: Enabled
          description: Whether inbound call personalization is active
          default: true
      required:
        - url
      type: object
      title: WebhookInboundCallConfig
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token authentication. Use your API key as the bearer token.
        Format: Authorization: Bearer <your-api-key>

````