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

> ## Agent Instructions
> For AgentScope Python, use https://docs.agentscope.io/stable/en/index for new projects. For existing projects, check the installed agentscope version and use matching versioned documentation.
> The /latest/ alias points to the newest documentation and may move ahead of /stable/ when a development version exists. Do not mix AgentScope 1.x and 2.x APIs.
> State the AgentScope version when providing installation commands or code examples. ReMe uses its own continuously updated /reme/latest/ documentation.

# List all voice profiles

> Return all voice profiles for the authenticated user.

Args:
    user_id (`str`): Injected authenticated user ID.
    storage (`StorageBase`): Injected storage backend.

Returns:
    `ListVoiceProfilesResponse`: All voice profiles.



## OpenAPI

````yaml /en/versions/2.0.12/deploy/openapi.json get /voice-profile/
openapi: 3.1.0
info:
  title: AgentScope
  version: 2.0.12
servers: []
security: []
paths:
  /voice-profile/:
    get:
      tags:
        - voice_profile
      summary: List all voice profiles
      description: |-
        Return all voice profiles for the authenticated user.

        Args:
            user_id (`str`): Injected authenticated user ID.
            storage (`StorageBase`): Injected storage backend.

        Returns:
            `ListVoiceProfilesResponse`: All voice profiles.
      operationId: list_voice_profiles_voice_profile__get
      parameters:
        - name: x-user-id
          in: header
          required: true
          schema:
            type: string
            description: >-
              Caller's user ID. Temporary header-based identity; will be
              replaced by JWT auth.
            title: X-User-Id
          description: >-
            Caller's user ID. Temporary header-based identity; will be replaced
            by JWT auth.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVoiceProfilesResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ListVoiceProfilesResponse:
      properties:
        profiles:
          items:
            $ref: '#/components/schemas/VoiceProfileRecord'
          type: array
          title: Profiles
        total:
          type: integer
          title: Total
      type: object
      required:
        - profiles
        - total
      title: ListVoiceProfilesResponse
      description: Response body for listing voice profiles.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    VoiceProfileRecord:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the credential.
        updated_at:
          type: string
          format: date-time
          title: Updated At
        created_at:
          type: string
          format: date-time
          title: Created At
        user_id:
          type: string
          title: User Id
        data:
          $ref: '#/components/schemas/VoiceProfileData'
      type: object
      required:
        - data
      title: VoiceProfileRecord
      description: The voice profile ORM model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    VoiceProfileData:
      properties:
        name:
          type: string
          title: Name
          description: Display name for this voice profile.
        engine:
          anyOf:
            - type: string
              enum:
                - cosyvoice
                - dashscope_tts
                - openai_tts
                - gemini_tts
            - type: 'null'
          title: Engine
          description: >-
            Preferred TTS engine: cosyvoice, dashscope_tts, openai_tts, or
            gemini_tts.
        model:
          anyOf:
            - type: string
            - type: 'null'
          title: Model
          description: >-
            Specific TTS model name for synthesis (e.g. 'qwen3-tts-flash',
            'cosyvoice-v3-flash').
        credential_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Credential ID
          description: >-
            Credential ID used for voice cloning and synthesis. Ensures the same
            API key is used for both operations.
        voice:
          anyOf:
            - type: string
            - type: 'null'
          title: Voice
          description: >-
            Voice identifier: preset name (e.g. 'alloy') or cloned voice ID from
            API.
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
          description: Engine-specific extra configuration.
      type: object
      required:
        - name
      title: VoiceProfileData
      description: The voice profile data model.

````

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