Listar vozes projetadas

OpenAPI

openapi: 3.1.0
info:
  title: CosyVoice Voice Design API — List voices
  version: 1.0.0
servers:
  - url: https://maas.qwencloudapi.com/api/v1
    description: Singapore
security:
  - BearerAuth: []
paths:
  /services/audio/tts/customization:
    post:
      operationId: listVoicesDesignCosyVoice
      summary: List designed voices
      description: Returns a list of CosyVoice designed voices with optional prefix filtering and pagination. Uses the same `voice-enrollment` model as voice cloning — use the `prefix` filter to narrow results (designed voices follow the pattern `{target_model}-vd-{prefix}-{unique_id}`).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ListRequest"
      responses:
        "200":
          description: Voices listed successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListResponse"
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST https://maas.qwencloudapi.com/api/v1/services/audio/tts/customization \
            -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
            -H "Content-Type: application/json" \
            -d '{
              "model": "voice-enrollment",
              "input": {
                "action": "list_voice",
                "prefix": "announcer",
                "page_size": 10,
                "page_index": 0
              }
            }'
components:
  schemas:
    ListRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          description: Fixed to `voice-enrollment`.
          enum:
            - voice-enrollment
          example: voice-enrollment
        input:
          type: object
          required:
            - action
          properties:
            action:
              type: string
              description: Fixed to `list_voice`.
              enum:
                - list_voice
              example: list_voice
            prefix:
              type: string
              description: Filter voices by name prefix.
              example: announcer
            page_index:
              type: integer
              description: Page number (0-indexed).
              default: 0
              example: 0
            page_size:
              type: integer
              description: Results per page.
              default: 10
              example: 10
    ListResponse:
      type: object
      properties:
        output:
          type: object
          properties:
            voice_list:
              type: array
              description: Array of voice objects.
              items:
                $ref: "#/components/schemas/VoiceItem"
        usage:
          type: object
          properties:
            count:
              type: integer
              description: Fixed as `1`.
              example: 1
        request_id:
          type: string
          description: Request ID for troubleshooting.
          example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    VoiceItem:
      type: object
      properties:
        voice_id:
          type: string
          description: Voice ID.
          example: cosyvoice-v3.5-plus-vd-announcer-xxxxxx
        gmt_create:
          type: string
          description: Creation timestamp.
          example: 2025-12-10 14:54:09
        gmt_modified:
          type: string
          description: Last modified timestamp.
          example: 2025-12-10 14:54:09
        status:
          type: string
          description: "Voice status: `DEPLOYING` (under review), `OK` (approved, usable), or `UNDEPLOYED` (not approved)."
          enum:
            - DEPLOYING
            - OK
            - UNDEPLOYED
          example: OK
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: DashScope API key. Get one at [API key](/api-reference/preparation/api-key).