> ## 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 available TTS engines

> Return TTS engines for which the user has a credential.

Args:
    user_id (`str`): Injected authenticated user ID.
    access (`ResourceAccessService`): Injected access service.

Returns:
    `AvailableEnginesResponse`: Available engine names.



## OpenAPI

````yaml /en/versions/2.0.12/deploy/openapi.json get /voice-profile/available-engines
openapi: 3.1.0
info:
  title: AgentScope
  version: 2.0.12
servers: []
security: []
paths:
  /voice-profile/available-engines:
    get:
      tags:
        - voice_profile
      summary: List available TTS engines
      description: |-
        Return TTS engines for which the user has a credential.

        Args:
            user_id (`str`): Injected authenticated user ID.
            access (`ResourceAccessService`): Injected access service.

        Returns:
            `AvailableEnginesResponse`: Available engine names.
      operationId: list_available_engines_voice_profile_available_engines_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/AvailableEnginesResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AvailableEnginesResponse:
      properties:
        engine_details:
          items:
            $ref: '#/components/schemas/EngineInfo'
          type: array
          title: Engine Details
          default: []
      type: object
      title: AvailableEnginesResponse
      description: Response body for available TTS engines.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EngineInfo:
      properties:
        name:
          type: string
          title: Name
        credential_type:
          type: string
          title: Credential Type
        models:
          items:
            $ref: '#/components/schemas/EngineModelInfo'
          type: array
          title: Models
          default: []
        voice_cloning:
          type: boolean
          title: Voice Cloning
          default: false
        credentials:
          items:
            $ref: '#/components/schemas/CredentialRef'
          type: array
          title: Credentials
          default: []
      type: object
      required:
        - name
        - credential_type
      title: EngineInfo
      description: Metadata about a TTS engine.
    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
    EngineModelInfo:
      properties:
        type:
          type: string
          const: tts_model
          title: Type
          default: tts_model
        name:
          type: string
          title: Name
          description: The name of the TTS model
        label:
          type: string
          title: Label
          description: The model label.
        status:
          type: string
          enum:
            - active
            - deprecated
            - sunset
          title: Status
          description: The model status
          default: active
        deprecated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deprecation date
          description: The model deprecation date and time.
        input_types:
          items:
            type: string
          type: array
          title: Input types
          description: The supported model input types.
          default:
            - text/plain
        output_types:
          items:
            type: string
          type: array
          title: Output types
          description: The supported model output types.
          default:
            - audio/wav
        realtime:
          type: boolean
          title: Realtime
          description: Whether the model supports streaming input (realtime).
          default: false
        voice_cloning:
          type: boolean
          title: Voice Cloning
          description: Whether the model supports voice cloning.
          default: false
        parameter_schema:
          additionalProperties: true
          type: object
          title: Parameter Schema
        parameters_overrides:
          additionalProperties:
            additionalProperties: true
            type: object
          type: object
          title: Parameters Overrides
        enrollment_model:
          anyOf:
            - type: string
            - type: 'null'
          title: Enrollment Model
      type: object
      required:
        - name
        - label
        - parameter_schema
        - parameters_overrides
      title: EngineModelInfo
      description: A selectable synthesis model and its enrollment model, if any.
    CredentialRef:
      properties:
        id:
          type: string
          title: Id
        label:
          type: string
          title: Label
      type: object
      required:
        - id
        - label
      title: CredentialRef
      description: Minimal credential reference for engine binding.

````

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