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

# Get an agent's realtime voice prompt template

> Returns the effective template (the agent's own copy, or the product default), the default, and every token with its current value for this agent, and the gpt-live-1 voices an agent may choose (realtimeVoices, defaultRealtimeVoice). Runtime-only values (call facts, contact profile) are illustrative samples.



## OpenAPI

````yaml https://api-trial.cognigy.ai/swagger/openapi.json get /agents/{id}/voice-prompt
openapi: 3.0.3
info:
  contact:
    email: support@example.com
    name: API Support
  description: API for managing agents and related resources
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://swagger.io/terms/
  title: Agents API
  version: '1.0'
servers:
  - url: https://api-trial.cognigy.ai/v1
security:
  - ApiKey: []
tags:
  - name: Agents
  - name: Brand personas
  - name: Tools
  - name: Built-in tools
  - name: Skills
  - name: Built-in skills
  - name: MCP servers
  - name: Tool references
paths:
  /agents/{id}/voice-prompt:
    get:
      tags:
        - Agents
      summary: Get an agent's realtime voice prompt template
      description: >-
        Returns the effective template (the agent's own copy, or the product
        default), the default, and every token with its current value for this
        agent, and the gpt-live-1 voices an agent may choose (realtimeVoices,
        defaultRealtimeVoice). Runtime-only values (call facts, contact profile)
        are illustrative samples.
      parameters:
        - description: The unique identifier for the agent.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_agents.VoicePromptResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_cognigy_ai-agents-v2_internal_middleware.ProblemDetailBadRequest
          description: Invalid agent ID format
        '403':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_cognigy_ai-agents-v2_internal_middleware.ProblemDetailForbidden
          description: Access denied
        '404':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_cognigy_ai-agents-v2_internal_middleware.ProblemDetailNotFound
          description: Agent not found
        '500':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_cognigy_ai-agents-v2_internal_middleware.ProblemDetailInternalError
          description: Internal server error
components:
  schemas:
    internal_agents.VoicePromptResponse:
      properties:
        defaultRealtimeVoice:
          description: >-
            DefaultRealtimeVoice is the voice used when the agent has not chosen
            one.
          example: marin
          type: string
        defaultTemplate:
          type: string
        isDefault:
          type: boolean
        realtimeVoices:
          description: |-
            RealtimeVoices are the gpt-live-1 built-in voices an agent's
            realtimeVoice may be set to.
          items:
            type: string
          type: array
        template:
          description: >-
            Template is the agent's own template, or the default when it has
            none.
          type: string
        tokens:
          items:
            $ref: '#/components/schemas/internal_agents.VoicePromptTokenResponse'
          type: array
      type: object
    github_com_cognigy_ai-agents-v2_internal_middleware.ProblemDetailBadRequest:
      properties:
        detail:
          example: request body validation failed
          type: string
        errors:
          items:
            $ref: >-
              #/components/schemas/github_com_cognigy_ai-agents-v2_internal_middleware.FieldError
          type: array
        instance:
          example: /v1/{resource}
          type: string
        status:
          example: 400
          type: integer
        title:
          example: Bad Request
          type: string
        traceId:
          example: api--a4d2f126-bec4-4544-a049-7c0cf08524ed
          type: string
        type:
          example: about:blank
          type: string
      type: object
    github_com_cognigy_ai-agents-v2_internal_middleware.ProblemDetailForbidden:
      properties:
        detail:
          example: 'access denied: insufficient permissions'
          type: string
        instance:
          example: /v1/{resource}/{id}
          type: string
        status:
          example: 403
          type: integer
        title:
          example: Forbidden
          type: string
        traceId:
          example: api--a4d2f126-bec4-4544-a049-7c0cf08524ed
          type: string
        type:
          example: about:blank
          type: string
      type: object
    github_com_cognigy_ai-agents-v2_internal_middleware.ProblemDetailNotFound:
      properties:
        detail:
          example: the requested resource does not exist
          type: string
        instance:
          example: /v1/{resource}/{id}
          type: string
        status:
          example: 404
          type: integer
        title:
          example: Not Found
          type: string
        traceId:
          example: api--a4d2f126-bec4-4544-a049-7c0cf08524ed
          type: string
        type:
          example: about:blank
          type: string
      type: object
    github_com_cognigy_ai-agents-v2_internal_middleware.ProblemDetailInternalError:
      properties:
        detail:
          example: internal server error
          type: string
        instance:
          example: /v1/{resource}
          type: string
        status:
          example: 500
          type: integer
        title:
          example: Internal Server Error
          type: string
        traceId:
          example: api--a4d2f126-bec4-4544-a049-7c0cf08524ed
          type: string
        type:
          example: about:blank
          type: string
      type: object
    internal_agents.VoicePromptTokenResponse:
      properties:
        covers:
          description: >-
            Covers lists the warnIfMissing tokens this block token renders;
            using it

            satisfies them.
          items:
            type: string
          type: array
        currentValue:
          description: >-
            CurrentValue is the token's value for this agent. Runtime-only
            values

            (call facts, contact profile) are illustrative samples.
          type: string
        description:
          type: string
        group:
          enum:
            - agent
            - capabilities
            - safety
            - persona
            - call
          type: string
        label:
          type: string
        selfContained:
          description: >-
            SelfContained: the value is a whole sentence or section, or empty,
            so an

            empty value is not warned about.
          type: boolean
        token:
          example: agent.tools
          type: string
        warnIfMissing:
          type: boolean
      type: object
    github_com_cognigy_ai-agents-v2_internal_middleware.FieldError:
      properties:
        field:
          type: string
        message:
          type: string
      type: object
  securitySchemes:
    ApiKey:
      description: '[Production] API key for production authentication'
      in: header
      name: X-API-Key
      type: apiKey

````