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

# Get voice agent details

> Retrieve a voice agent’s configuration.

Keep returned credentials private.


## OpenAPI

````yaml openapi.json GET /voice/agents/{agent_id}
openapi: 3.1.0
info:
  title: Karta Public API
  version: 1.0.0-draft
  description: >-
    Karta API reference for accounts, agents, calls, campaigns, WebSocket
    sessions, and billing.
servers:
  - url: https://api.getkarta.ai/public/v1
    description: Production
security:
  - BearerApiKey: []
tags:
  - name: Account
  - name: Agents
  - name: Calls
  - name: Phone numbers
  - name: Campaigns
  - name: Realtime
  - name: Billing
  - name: Webhooks
    description: Outgoing call events delivered to your server.
paths:
  /voice/agents/{agent_id}:
    get:
      tags:
        - Agents
      summary: Get voice agent details
      description: Retrieve a voice agent’s configuration.
      operationId: getVoiceAgent
      parameters:
        - name: X-Request-ID
          in: header
          required: false
          description: Optional request-tracing identifier.
          schema:
            type: string
          example: example-request-001
        - name: agent_id
          in: path
          required: true
          description: >-
            Voice agent ID returned by List agents; underscores are not
            supported.
          schema:
            type: string
          example: agentexample
      responses:
        '200':
          description: Successful response.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceAgent'
              example:
                agentId: agentexample
                customerDetails:
                  dataResidencyRegion: IN
                languageConfig:
                  primaryLanguage: en
                  secondaryLanguages: []
                languageDefaultsConfig: null
                agentDetails:
                  instructions: SGVscCBjdXN0b21lcnMgd2l0aCB0aGVpciBxdWVzdGlvbnMu
                  dynamicVariables: []
                  agentName: Example support agent
                  updatedAt: null
                welcomeMessageConfig: null
                STTConfigs: []
                agentVoiceConfigs: []
                experimental:
                  ttsCache: true
                pronunciationDictionaryConfigs: null
                LLMConfigs: []
                ToolsConfig: []
                CustomToolsConfig: []
                inboundWebhookConfigs: []
                SpeechConfigs:
                  responsiveness: 1
                  interruptionSensitivity: 1
                  idleUserTimeoutMs: 10000
                  minConsecutiveSpeechDelay: 1
                  discardAudioDuringInterruption: true
                  maxEndpointingDelayBase: 2.5
                  endpointingMode: fixed
                  dtmfEnabled: false
                  toolEngagingMessageEnabled: false
                turnDetectionConfigs:
                  turnDetectionModel: vad
                  modelConfig: {}
                PostCallAnalysisConfigs: []
                voicemailDetectionConfig:
                  detection_duration_ms: 3000
                  llm_settings: {}
                agentKBConfig:
                  topn: 3
                  enableKB: false
                agentContextConfig:
                  kbStoreConfig:
                    maxChunkCount: 10
                    maxToken: 5000
                intentConfig:
                  enableIntentWorkflow: false
                  intentIdentificationConfig:
                    instructions: ''
                    intentThreshold: 0.4
                    categories: []
                    categoryDescription: ''
                  intentEscalationConfig:
                    instructions: ''
                widgetConfig: null
                useNumberPool: false
                createdAt: null
                updatedAt: null
                postCallWorkFlow: []
        '400':
          description: Invalid request or account configuration.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/AuthProblem'
                    title: Authentication or account configuration error
                  - $ref: '#/components/schemas/RequestProcessingError'
                    title: Request processing error
              examples:
                configuration:
                  summary: Account configuration error
                  value:
                    type: https://httpstatus.es/400
                    title: Missing Data Residency
                    status: 400
                    detail: Client dataResidency not set. Please contact support.
                    instance: example-request-001
                    code: missing_data_residency
                request:
                  summary: Request parsing error (illustrative message)
                  value:
                    message: Unexpected end of JSON input
        '401':
          description: Authentication failed.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthProblem'
                title: Authentication or account configuration error
              examples:
                authentication:
                  summary: Missing API key
                  value:
                    type: https://httpstatus.es/401
                    title: Invalid API Key
                    status: 401
                    detail: API key is required
                    instance: example-request-001
                    code: invalid_api_key
        '403':
          description: API key not permitted for this operation.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthProblem'
                title: Authentication or account configuration error
              examples:
                authentication:
                  summary: Wrong key type
                  value:
                    type: https://httpstatus.es/403
                    title: Wrong API Key Type
                    status: 403
                    detail: Widget API keys may only be used on /widget paths
                    instance: example-request-001
                    code: wrong_key_audience
        '404':
          description: Agent configuration could not be retrieved for this account.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/VoiceProblem'
                title: Voice service error
              example:
                type: https://api.karta.com/problems/not-found
                title: Not Found
                status: 404
                detail: agent not found
                instance: /voice/public/v1/agents/{agent_id}
                trace_id: example-request-001
        '422':
          description: Request validation failed.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/VoiceProblem'
                title: Voice service error
              example:
                type: https://api.karta.com/problems/validation-error
                title: Unprocessable Entity
                status: 422
                detail: Validation failed
                instance: /voice/public/v1/agents/{agent_id}
                trace_id: example-request-001
                errors:
                  - path: header.X-Client-ID
                    message: Field required
                    type: missing
        '500':
          description: Internal server error.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/AuthProblem'
                    title: Authentication or account configuration error
                  - $ref: '#/components/schemas/RequestProcessingError'
                    title: Request processing error
                  - $ref: '#/components/schemas/ProxyConnectionError'
                    title: Upstream connection error
              examples:
                authentication:
                  summary: Authentication failure
                  value:
                    type: https://httpstatus.es/500
                    title: Internal Server Error
                    status: 500
                    detail: Authentication failed
                    instance: example-request-001
                    code: internal_error
                request:
                  summary: Request processing failure
                  value:
                    message: Internal Server Error
                ProxyConnectionError:
                  summary: Upstream connection failure
                  value:
                    error: Internal Server Error
                    message: Error connecting to voice agent service
            application/problem+json:
              schema:
                $ref: '#/components/schemas/VoiceProblem'
                title: Voice service error
              example:
                type: https://api.karta.com/problems/internal-server-error
                title: Internal Server Error
                status: 500
                detail: An internal server error occurred
                instance: /voice/public/v1/agents/{agent_id}
                trace_id: example-request-001
components:
  schemas:
    VoiceAgent:
      description: Voice agent configuration.
      properties:
        agentId:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Agent identifier
          title: Agentid
        customerDetails:
          $ref: '#/components/schemas/VoiceAgentCustomerDetails'
          description: Customer configuration
        languageConfig:
          $ref: '#/components/schemas/VoiceAgentLanguageConfig'
          description: Language configuration
        languageDefaultsConfig:
          anyOf:
            - $ref: '#/components/schemas/VoiceAgentLanguageDefaults'
            - type: 'null'
          default: null
          description: Optional per-language default message configuration
        agentDetails:
          $ref: '#/components/schemas/VoiceAgentAgentDetails'
          description: Agent details configuration
        welcomeMessageConfig:
          anyOf:
            - $ref: '#/components/schemas/VoiceAgentWelcomeMessageConfig'
            - type: 'null'
          default: null
          description: Welcome message behaviour configuration
        STTConfigs:
          description: List of STT provider configurations for this agent
          items:
            $ref: '#/components/schemas/VoiceAgentSTTConfigEntry'
          title: Sttconfigs
          type: array
        agentVoiceConfigs:
          description: List of voice configurations for this agent
          items:
            $ref: '#/components/schemas/VoiceAgentAgentVoiceConfig'
          title: Agentvoiceconfigs
          type: array
        experimental:
          additionalProperties: true
          description: Experimental feature flags
          title: Experimental
          type: object
        pronunciationDictionaryConfigs:
          anyOf:
            - $ref: '#/components/schemas/VoiceAgentPronunciationDictionaryConfig'
            - type: 'null'
          default: null
          description: Pronunciation dictionary config with rules and provider metadata
        LLMConfigs:
          description: List of LLM provider configurations for this agent
          items:
            $ref: '#/components/schemas/VoiceAgentLLMPConfigEntry'
          title: Llmconfigs
          type: array
        ToolsConfig:
          description: List of tool configurations available to the agent
          items:
            $ref: '#/components/schemas/VoiceAgentToolConfigEntry'
          title: Toolsconfig
          type: array
        CustomToolsConfig:
          description: List of custom tool configurations available to the agent
          items:
            $ref: '#/components/schemas/VoiceAgentCustomToolConfig'
          title: Customtoolsconfig
          type: array
        inboundWebhookConfigs:
          description: List of inbound webhook configurations for the agent
          items:
            $ref: '#/components/schemas/VoiceAgentInboundWebhookConfig'
          title: Inboundwebhookconfigs
          type: array
        SpeechConfigs:
          $ref: '#/components/schemas/VoiceAgentSpeechConfigEntry'
          description: Speech configurations for this agent
        turnDetectionConfigs:
          $ref: '#/components/schemas/VoiceAgentTurnDetectionConfigEntry'
          description: Turn detection configurations for this agent
        PostCallAnalysisConfigs:
          description: List of post call analysis configurations for this agent
          items:
            $ref: '#/components/schemas/VoiceAgentPostCallAnalysisConfigEntry'
          title: Postcallanalysisconfigs
          type: array
        voicemailDetectionConfig:
          $ref: '#/components/schemas/VoiceAgentVoicemailDetectionConfigEntry'
          description: Voicemail detection configuration for this agent
        agentKBConfig:
          $ref: '#/components/schemas/VoiceAgentAgentKBConfigEntry'
          description: Knowledge base configuration for this agent
        agentContextConfig:
          $ref: '#/components/schemas/VoiceAgentAgentContextConfigEntry'
          description: Agent context configuration for this agent
        intentConfig:
          $ref: '#/components/schemas/VoiceAgentIntentConfigEntry'
          description: Intent identification and escalation configuration
        widgetConfig:
          anyOf:
            - $ref: '#/components/schemas/VoiceAgentWidgetConfig'
            - type: 'null'
          default: null
          description: Widget configuration for the agent
        useNumberPool:
          default: false
          description: Use a random eligible caller ID for outbound calls
          title: Usenumberpool
          type: boolean
        createdAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
          description: Creation timestamp
          title: Createdat
        updatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
          description: Last update timestamp
          title: Updatedat
        postCallWorkFlow:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: List of post call workflow configurations for this agent
          title: Postcallworkflow
      title: Voice agent configuration
      type: object
    AuthProblem:
      type: object
      properties:
        type:
          type: string
          description: Identifier for this error category.
        title:
          type: string
          description: Short summary of the error.
        status:
          type: integer
          description: HTTP status code for this response.
        detail:
          type: string
          description: Explanation of the failure.
        instance:
          type: string
          description: Request identifier.
        code:
          type: string
          description: Machine-readable error code.
      title: Authentication or account configuration error
    RequestProcessingError:
      title: Request processing error
      type: object
      properties:
        message:
          type: string
          description: Description of the request-processing failure.
        errors:
          type: array
          items:
            additionalProperties: true
            type: object
          description: Additional error details, when supplied.
    VoiceProblem:
      type: object
      properties:
        type:
          type: string
          description: Identifier for this error category.
        title:
          type: string
          description: Short summary of the error.
        status:
          type: integer
          description: HTTP status code for this response.
        detail:
          type: string
          description: Explanation of the failure.
        instance:
          type: string
          description: Request path.
        trace_id:
          type: string
          description: Request identifier for support and troubleshooting.
        errors:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
              type:
                type: string
      title: Voice service error
    ProxyConnectionError:
      title: Upstream connection error
      type: object
      properties:
        error:
          type: string
          enum:
            - Internal Server Error
          description: Machine-readable error code.
        message:
          type: string
          description: Explanation of the failure.
    VoiceAgentCustomerDetails:
      description: Customer configuration.
      properties:
        dataResidencyRegion:
          $ref: '#/components/schemas/VoiceAgentDataResidencyRegion'
          description: Data residency region
      title: CustomerDetails
      type: object
    VoiceAgentLanguageConfig:
      description: Language settings.
      properties:
        primaryLanguage:
          $ref: '#/components/schemas/VoiceAgentLanguageCode'
          description: Primary language used as the fallback language for the agent.
        secondaryLanguages:
          description: Secondary languages used for the agent
          items:
            $ref: '#/components/schemas/VoiceAgentLanguageCode'
          title: Secondarylanguages
          type: array
      title: LanguageConfig
      type: object
    VoiceAgentLanguageDefaults:
      description: Optional per-language message overrides.
      properties:
        welcomeMessage:
          $ref: '#/components/schemas/VoiceAgentCustomMessageConfig'
        customTransferMessage:
          $ref: '#/components/schemas/VoiceAgentCustomMessageConfig'
        customTransferToAgentMessage:
          $ref: '#/components/schemas/VoiceAgentCustomMessageConfig'
        customTransferFailureMessage:
          $ref: '#/components/schemas/VoiceAgentCustomMessageConfig'
        customBusinessHourFailureMessage:
          $ref: '#/components/schemas/VoiceAgentCustomMessageConfig'
        customEscalationMessage:
          $ref: '#/components/schemas/VoiceAgentCustomMessageConfig'
        customIdleUserReminderMessage:
          $ref: '#/components/schemas/VoiceAgentCustomMessageConfig'
        customIdleUserDisconnectMessage:
          $ref: '#/components/schemas/VoiceAgentCustomMessageConfig'
      title: LanguageDefaults
      type: object
    VoiceAgentAgentDetails:
      description: Voice agent details.
      properties:
        instructions:
          anyOf:
            - type: string
            - type: 'null'
          default: ''
          description: Base64-encoded agent instructions.
          title: Instructions
        dynamicVariables:
          description: Dynamic variable names referenced in agent instructions
          items:
            type: string
          title: Dynamicvariables
          type: array
        agentName:
          description: Name of the agent
          title: Agentname
          type: string
        updatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
          description: Last update timestamp for details
          title: Updatedat
      title: AgentDetails
      type: object
    VoiceAgentWelcomeMessageConfig:
      description: Grouped configuration for welcome-message behaviour.
      properties:
        welcomeMessage:
          default: ''
          description: Welcome message text spoken to the user
          title: Welcomemessage
          type: string
        agentSpeaksFirst:
          default: true
          description: >-
            If true, agent speaks the welcome message immediately. If false,
            agent waits for the user to speak first.
          title: Agentspeaksfirst
          type: boolean
        welcomeMessageDelay:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: >-
            Seconds to wait before the agent delivers the welcome message when
            agentSpeaksFirst is false.
          title: Welcomemessagedelay
        agentMessageInterruptable:
          default: false
          description: >-
            Whether the welcome message can be interrupted while the agent is
            speaking.
          title: Agentmessageinterruptable
          type: boolean
      title: WelcomeMessageConfig
      type: object
    VoiceAgentSTTConfigEntry:
      description: Single STT configuration entry for the agent.
      properties:
        sttProvider:
          $ref: '#/components/schemas/VoiceAgentSTTProvider'
          description: STT provider type
        sttProviderConfigs:
          additionalProperties: true
          description: Provider-specific configuration (dynamic)
          title: Sttproviderconfigs
          type: object
        sttPromptConfig:
          anyOf:
            - $ref: '#/components/schemas/VoiceAgentSTTPromptConfig'
            - type: 'null'
          default: null
          description: Provider-agnostic STT prompting hints (keywords, context text)
        updatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
          description: Last update timestamp for this STT config
          title: Updatedat
      title: STTConfigEntry
      type: object
    VoiceAgentAgentVoiceConfig:
      description: Single voice configuration entry for an agent.
      properties:
        ttsProvider:
          $ref: '#/components/schemas/VoiceAgentTTSProvider'
          description: TTS provider type
        ttsProviderConfigs:
          additionalProperties: true
          description: Provider-specific configuration (dynamic)
          title: Ttsproviderconfigs
          type: object
        otherConfigs:
          additionalProperties: true
          description: Additional voice settings, such as background sound and volume.
          title: Otherconfigs
          type: object
        updatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
          description: Last update timestamp for this voice config
          title: Updatedat
      title: AgentVoiceConfig
      type: object
    VoiceAgentPronunciationDictionaryConfig:
      description: >-
        Pronunciation dictionary config with rules and provider-specific
        metadata.
      properties:
        rules:
          items:
            $ref: '#/components/schemas/VoiceAgentPronunciationDictionaryRule'
          title: Rules
          type: array
        elevenlabs_india:
          anyOf:
            - $ref: '#/components/schemas/VoiceAgentElevenLabsDictionaryConfig'
            - type: 'null'
          default: null
          description: ElevenLabs dictionary config
        cartesia:
          anyOf:
            - $ref: '#/components/schemas/VoiceAgentCartesiaDictionaryConfig'
            - type: 'null'
          default: null
          description: Cartesia dictionary config
        sarvam_india:
          anyOf:
            - $ref: '#/components/schemas/VoiceAgentSarvamDictionaryConfig'
            - type: 'null'
          default: null
          description: Sarvam dictionary config
      title: PronunciationDictionaryConfig
      type: object
    VoiceAgentLLMPConfigEntry:
      description: Language model configuration.
      properties:
        LLMProvider:
          $ref: '#/components/schemas/VoiceAgentLLMProvider'
        LLMProviderConfigs:
          additionalProperties: true
          title: Llmproviderconfigs
          type: object
      title: LLMPConfigEntry
      type: object
    VoiceAgentToolConfigEntry:
      description: Tool configuration.
      properties:
        toolName:
          description: Canonical tool id used for lookup (e.g. transfer_to_agent)
          title: Toolname
          type: string
        toolDescription:
          description: Human-readable description of the tool
          title: Tooldescription
          type: string
        llmToolName:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Optional LLM-facing function name override; defaults to toolName
            when unset
          title: Llmtoolname
        toolParams:
          additionalProperties: true
          description: Dynamic parameters for the tool
          title: Toolparams
          type: object
      title: ToolConfigEntry
      type: object
    VoiceAgentCustomToolConfig:
      description: Custom tool configuration.
      properties:
        toolID:
          description: ID of the custom tool
          title: Toolid
          type: string
        toolName:
          description: Display name of the custom tool
          title: Toolname
          type: string
        toolDescription:
          description: Description of what the custom tool does
          title: Tooldescription
          type: string
        async_method:
          default: false
          description: Whether the custom tool should run in the background
          title: Async Method
          type: boolean
        dateTime:
          description: Timestamp for the custom tool
          format: date-time
          title: Datetime
          type: string
      title: CustomToolConfig
      type: object
    VoiceAgentInboundWebhookConfig:
      description: Configuration for inbound webhooks.
      properties:
        inboundWebhookID:
          description: ID of the inbound webhook
          title: Inboundwebhookid
          type: string
        updatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
          description: Last update timestamp for this webhook config
          title: Updatedat
      title: InboundWebhookConfig
      type: object
    VoiceAgentSpeechConfigEntry:
      description: Single speech configuration entry for the agent.
      properties:
        responsiveness:
          default: 1
          title: Responsiveness
          type: number
        interruptionSensitivity:
          default: 1
          title: Interruptionsensitivity
          type: number
        idleUserTimeoutMs:
          default: 10000
          description: Time before triggering idle-user prompts, in milliseconds
          title: Idleusertimeoutms
          type: integer
        minConsecutiveSpeechDelay:
          default: 1
          title: Minconsecutivespeechdelay
          type: number
        discardAudioDuringInterruption:
          default: true
          description: Discard audio during interruption of the agent
          title: Discardaudioduringinterruption
          type: boolean
        maxEndpointingDelayBase:
          default: 2.5
          description: Base value for max endpointing delay in seconds
          title: Maxendpointingdelaybase
          type: number
        endpointingMode:
          default: fixed
          description: >-
            Endpointing mode: 'fixed' uses static delays, 'dynamic' adapts
            delays based on conversation pause statistics
          enum:
            - fixed
            - dynamic
          title: Endpointingmode
          type: string
        dtmfEnabled:
          default: false
          description: >-
            Enable receiving caller keypad (DTMF) input. Buffered digits are
            delivered to the agent when the caller presses '#'.
          title: Dtmfenabled
          type: boolean
        toolEngagingMessageEnabled:
          default: false
          description: Enable engaging messages while eligible tools run
          title: Toolengagingmessageenabled
          type: boolean
      title: SpeechConfigEntry
      type: object
    VoiceAgentTurnDetectionConfigEntry:
      description: Single turn detection configuration entry for the agent.
      properties:
        turnDetectionModel:
          default: vad
          description: Turn detection model of the agent
          title: Turndetectionmodel
          type: string
        modelConfig:
          additionalProperties: true
          description: Extra configuration for the turn detection model
          title: Modelconfig
          type: object
      title: TurnDetectionConfigEntry
      type: object
    VoiceAgentPostCallAnalysisConfigEntry:
      description: Single post call analysis configuration entry for the agent.
      properties:
        name:
          description: Name of the post call analysis
          title: Name
          type: string
        type:
          description: Type of the post call analysis
          title: Type
          type: string
        description:
          description: Description of the post call analysis
          title: Description
          type: string
        choices:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          default: null
          description: Available choices for Selector type analysis
          title: Choices
      title: PostCallAnalysisConfigEntry
      type: object
    VoiceAgentVoicemailDetectionConfigEntry:
      description: Single voicemail detection configuration entry for the agent.
      properties:
        detection_duration_ms:
          description: Detection duration in milliseconds
          title: Detection Duration Ms
          type: integer
        llm_settings:
          additionalProperties: true
          description: LLM settings for the voicemail detection
          title: Llm Settings
          type: object
      title: VoicemailDetectionConfigEntry
      type: object
    VoiceAgentAgentKBConfigEntry:
      description: Single knowledge base configuration entry for the agent.
      properties:
        topn:
          description: Number of top results to return
          title: Topn
          type: integer
        enableKB:
          description: Enable knowledge base
          title: Enablekb
          type: boolean
      title: AgentKBConfigEntry
      type: object
    VoiceAgentAgentContextConfigEntry:
      description: Agent context configuration entry for the agent.
      properties:
        kbStoreConfig:
          $ref: '#/components/schemas/VoiceAgentKBStoreConfigEntry'
          description: Knowledge base store configuration limits
      title: AgentContextConfigEntry
      type: object
    VoiceAgentIntentConfigEntry:
      description: Top-level intent configuration toggle and nested configs.
      properties:
        enableIntentWorkflow:
          default: false
          description: Enable intent identification flow before escalation
          title: Enableintentworkflow
          type: boolean
        intentIdentificationConfig:
          $ref: '#/components/schemas/VoiceAgentIntentIdentificationConfig'
          description: Configuration for intent identification task
        intentEscalationConfig:
          $ref: '#/components/schemas/VoiceAgentIntentEscalationConfig'
          description: Configuration for escalation task when identification fails
      title: IntentConfigEntry
      type: object
    VoiceAgentWidgetConfig:
      description: Widget configuration for the agent.
      properties:
        interactionMode:
          $ref: '#/components/schemas/VoiceAgentInteractionMode'
          description: Interaction mode of the widget
      title: WidgetConfig
      type: object
    VoiceAgentDataResidencyRegion:
      enum:
        - IN
        - GLOBAL
      title: DataResidencyRegion
      type: string
    VoiceAgentLanguageCode:
      enum:
        - as
        - bh
        - bn
        - gu
        - hi
        - kn
        - ks
        - ml
        - mr
        - ne
        - or
        - pa
        - sa
        - sd
        - ta
        - te
        - ur
        - aa
        - ab
        - ae
        - af
        - ak
        - am
        - an
        - ar
        - av
        - ay
        - az
        - ba
        - be
        - bg
        - bi
        - bm
        - bo
        - br
        - bs
        - ca
        - ce
        - ch
        - co
        - cr
        - cs
        - cu
        - cv
        - cy
        - da
        - de
        - dv
        - dz
        - ee
        - en
        - el
        - eo
        - es
        - et
        - eu
        - fa
        - ff
        - fi
        - fj
        - fo
        - fr
        - fy
        - ga
        - gd
        - gl
        - gn
        - ha
        - he
        - ho
        - hr
        - ht
        - hu
        - hy
        - hz
        - ia
        - id
        - ie
        - ig
        - ii
        - ik
        - io
        - is
        - it
        - iu
        - ja
        - jv
        - ka
        - kg
        - ki
        - kj
        - kk
        - kl
        - km
        - ko
        - kr
        - ku
        - kv
        - kw
        - ky
        - la
        - lb
        - lg
        - li
        - ln
        - lo
        - lt
        - lu
        - lv
        - mg
        - mh
        - mi
        - mk
        - mn
        - ms
        - mt
        - my
        - na
        - nb
        - nd
        - ng
        - nl
        - nn
        - 'no'
        - nr
        - nv
        - ny
        - oc
        - oj
        - om
        - os
        - pi
        - pl
        - ps
        - pt
        - qu
        - rm
        - rn
        - ro
        - ru
        - rw
        - sc
        - se
        - sg
        - si
        - sk
        - sl
        - sm
        - sn
        - so
        - sq
        - sr
        - ss
        - st
        - su
        - sv
        - sw
        - tg
        - th
        - ti
        - tk
        - tl
        - tn
        - to
        - tr
        - ts
        - tt
        - tw
        - ty
        - ug
        - uk
        - uz
        - ve
        - vi
        - vo
        - wa
        - wo
        - xh
        - yi
        - yo
        - za
        - zh
        - zu
        - unknown
      title: LanguageCode
      type: string
    VoiceAgentCustomMessageConfig:
      additionalProperties: false
      description: Localized message map with an enable toggle.
      properties:
        map:
          additionalProperties:
            type: string
          description: Localized messages keyed by language code.
          title: Map
          type: object
        enabled:
          default: true
          description: Whether to speak this message.
          title: Enabled
          type: boolean
      title: CustomMessageConfig
      type: object
    VoiceAgentSTTProvider:
      enum:
        - deepgram
        - soniox
        - google_india
        - sarvam_india
        - livekit
        - deepgram_india
        - elevenlabs_india
      title: STTProvider
      type: string
    VoiceAgentSTTPromptConfig:
      description: Hints to improve speech recognition.
      properties:
        keywords:
          description: >-
            Words or short phrases to bias STT recognition toward (max 100
            items)
          items:
            type: string
          maxItems: 100
          title: Keywords
          type: array
        contextText:
          anyOf:
            - maxLength: 2000
              type: string
            - type: 'null'
          default: null
          description: Free-text context to improve transcription accuracy
          title: Contexttext
      title: STTPromptConfig
      type: object
    VoiceAgentTTSProvider:
      enum:
        - elevenlabs_india
        - cartesia
        - sarvam_india
        - google_india
      title: TTSProvider
      type: string
    VoiceAgentPronunciationDictionaryRule:
      description: Single pronunciation rule entry.
      properties:
        word:
          description: The word to replace
          minLength: 1
          title: Word
          type: string
        alphabet:
          description: 'Alphabet type: ''ipa'' or ''cmu'''
          enum:
            - ipa
            - cmu
          title: Alphabet
          type: string
        phoneme:
          description: Phoneme transcription
          minLength: 1
          title: Phoneme
          type: string
      title: PronunciationDictionaryRule
      type: object
    VoiceAgentElevenLabsDictionaryConfig:
      description: ElevenLabs-specific pronunciation dictionary configuration.
      properties:
        pronunciationDictionaryId:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: ElevenLabs dictionary id
          title: Pronunciationdictionaryid
        versionId:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: ElevenLabs dictionary version id
          title: Versionid
      title: ElevenLabsDictionaryConfig
      type: object
    VoiceAgentCartesiaDictionaryConfig:
      description: Cartesia-specific pronunciation dictionary configuration.
      properties:
        pronunciationDictionaryId:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Cartesia dictionary id
          title: Pronunciationdictionaryid
      title: CartesiaDictionaryConfig
      type: object
    VoiceAgentSarvamDictionaryConfig:
      description: Sarvam-specific pronunciation dictionary configuration.
      properties:
        pronunciationDictionaryId:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Sarvam dictionary id
          title: Pronunciationdictionaryid
      title: SarvamDictionaryConfig
      type: object
    VoiceAgentLLMProvider:
      enum:
        - openai
        - google_india
        - azure_openai_india
        - azure_foundry
        - groq
        - baseten
      title: LLMProvider
      type: string
    VoiceAgentKBStoreConfigEntry:
      description: Limits/config for how agent context/KB chunks are stored.
      properties:
        maxChunkCount:
          default: 10
          description: Maximum number of chunks to keep
          minimum: 1
          title: Maxchunkcount
          type: integer
        maxToken:
          default: 5000
          description: Maximum token budget for stored chunks
          minimum: 1
          title: Maxtoken
          type: integer
      title: KBStoreConfigEntry
      type: object
    VoiceAgentIntentIdentificationConfig:
      description: Intent identification task configuration.
      properties:
        instructions:
          default: ''
          description: Prompt instructions to identify user intent
          title: Instructions
          type: string
        intentThreshold:
          default: 0.4
          description: Relevance threshold to accept an intent match
          title: Intentthreshold
          type: number
        categories:
          description: Optional list of intent categories for LLM categorisation/routing
          items:
            type: string
          title: Categories
          type: array
        categoryDescription:
          default: ''
          description: Description/context for the provided categories
          title: Categorydescription
          type: string
      title: IntentIdentificationConfig
      type: object
    VoiceAgentIntentEscalationConfig:
      description: Escalation configuration when no suitable intent match is found.
      properties:
        instructions:
          default: ''
          description: Prompt instructions to guide escalation behaviour
          title: Instructions
          type: string
      title: IntentEscalationConfig
      type: object
    VoiceAgentInteractionMode:
      enum:
        - voice
        - chat
        - vision
      title: InteractionMode
      type: string
  securitySchemes:
    BearerApiKey:
      type: http
      scheme: bearer
      description: 'API key in the format: Bearer YOUR_KARTA_API_KEY.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.