Nuance Voices API

openapi: 3.2.0
info:
  title: Mix.api Specification Voices API
  version: 26.1026.216
security:
- OAuth2:
  - mix-api
  bearerAuth: []
tags:
- name: Voices
paths:
  /v4/organizations/{orgId}/voices:
    get:
      summary: Get voices
      description: Retrieve the list of voices available in the organization specified.
      operationId: MixAPI_ListVoices
      responses:
        '200':
          description: List of voices
          content:
            application/json:
              schema:
                type: array
                $ref: '#/components/schemas/mix.api.ListVoicesResponse'
        '401':
          description: Request could not be authorized
          content:
            application/json:
              schema: {}
        '500':
          description: Internal server error
          content:
            application/json:
              schema: {}
        '501':
          description: Feature is not yet enabled
          content:
            application/json:
              schema: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: orgId
        description: ID of the organization for which to get the list of voices.
        in: path
        required: true
        schema:
          type: string
      tags:
      - Voices
components:
  schemas:
    google.protobuf.Any:
      type: object
      properties:
        type_url:
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
        value:
          type: string
          format: byte
          description: Must be a valid serialized protocol buffer of the above specified type.
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n    // or ...\n    if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n      foo = any.unpack(Foo.getDefaultInstance());\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    mix.api.Voice.VoiceModel:
      type: string
      enum:
      - ENHANCED
      - STANDARD
      - NEURAL
      default: ENHANCED
      description: "Voice quality model.\n\n - ENHANCED: Concatenative speech model with neural postprocessing.\n - STANDARD: Concatenative speech model.\n - NEURAL: Microsoft end-to-end generative models."
    grpc.gateway.runtime.Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
    mix.api.Voice:
      type: object
      properties:
        name:
          type: string
          description: Name of the voice, for example, 'Evan'.
        restricted:
          type: boolean
          description: Identifies whether the voice is restricted. These are custom voices available only to specific customers.
        gender:
          $ref: '#/components/schemas/mix.api.Voice.VoiceGender'
          description: Voice gender.
        model:
          $ref: '#/components/schemas/mix.api.Voice.VoiceModel'
          description: Voice quality model, for example, 'enhanced', 'standard', or 'neural'.
        locale:
          type: string
          description: Language code.
        sampleRateHz:
          type: array
          items:
            type: integer
            format: int64
          description: Native sample rates.
        foreignLanguages:
          type: array
          items:
            type: string
          description: Foreign languages of a multilingual voice.
        styles:
          type: array
          items:
            type: string
          description: Available styles of a voice.
    mix.api.Voice.VoiceGender:
      type: string
      enum:
      - ANY
      - MALE
      - FEMALE
      - NEUTRAL
      default: ANY
      description: "Voice gender.\n\n - ANY: Any gender voice.\n - MALE: Male voice.\n - FEMALE: Female voice.\n - NEUTRAL: Neutral gender voice."
    mix.api.ListVoicesResponse:
      type: object
      example:
        voices:
        - name: Allison
          restricted: false
          gender: FEMALE
          model: STANDARD
          locale: en-US
          sampleRateHz:
          - 22050
          foreignLanguages: []
          styles: []
        - name: Christina-Ml
          restricted: true
          gender: FEMALE
          model: STANDARD
          locale: de-DE
          sampleRateHz:
          - 22050
          foreignLanguages:
          - en-US
          - en-GB
          - fr-FR
          - es-ES
          - it-IT
          styles: []
        - name: Erica
          restricted: true
          gender: FEMALE
          model: STANDARD
          locale: en-US
          sampleRateHz:
          - 22050
          - 8000
          foreignLanguages: []
          styles: []
        - name: en-US-GuyNeural
          restricted: false
          gender: MALE
          model: NEURAL
          locale: en-US
          sampleRateHz:
          - 24000
          foreignLanguages: []
          styles:
          - newscast
          - angry
          - cheerful
          - sad
          - excited
          - friendly
          - terrified
          - shouting
          - unfriendly
          - whispering
          - hopeful
      properties:
        voices:
          type: array
          items:
            $ref: '#/components/schemas/mix.api.Voice'
          description: List of voices.
      description: Response object returned by the Get voices request.
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            mix-api: Grants access to mix-api
          tokenUrl: /oauth2/token
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header