Microsoft Azure Speech Services API V20

swagger: '2.0'
info:
  title: Microsoft Azure Speech Services API v2.0
  description: Speech Services API v2.0.
  contact:
    name: Cognitive Services - Speech Services
    url: https://docs.microsoft.com/azure/cognitive-services/speech-service/support
  version: v2.0
paths:
  /accuracytests:
    get:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Gets The List Of Accuracy Tests For The Authenticated Subscription'
      operationId: microsoftAzureGetaccuracytests
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Test'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all accuracy tests:
          $ref: ./examples/get_accuracy_tests.json
      description: Needs a more full description created.
    post:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Creates A New Accuracy Test'
      operationId: microsoftAzureCreateaccuracytest
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: testDefinition
          description: The details of the new accuracy test.
          required: true
          schema:
            $ref: '#/definitions/TestDefinition'
      responses:
        '202':
          description: >-
            The request was accepted and the response contains the location of
            the entity.
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait before accessing the
                resource created in this operation.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create an accuracy test:
          $ref: ./examples/create_accuracy_test.json
      description: Needs a more full description created.
  /accuracytests/{id}:
    get:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Gets The Accuracy Test Identified By The Given Id'
      operationId: microsoftAzureGetaccuracytest
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the accuracy test.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Test'
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait for a non terminal
                operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get an accuracy test:
          $ref: ./examples/get_accuracy_test.json
      description: Needs a more full description created.
    patch:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Updates The Mutable Details Of The Test Identified By Its Id'
      operationId: microsoftAzureUpdateaccuracytest
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the accuracy test.
          required: true
          type: string
          format: uuid
        - in: body
          name: testUpdate
          description: The object containing the updated fields of the test.
          required: true
          schema:
            $ref: '#/definitions/TestUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Test'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update an accuracy test:
          $ref: ./examples/update_accuracy_test.json
      description: Needs a more full description created.
    delete:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Deletes The Accuracy Test Identified By The Given Id'
      operationId: microsoftAzureDeleteaccuracytest
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the accuracy test.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The test was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete an accuracy test:
          $ref: ./examples/delete_accuracy_test.json
      description: Needs a more full description created.
  /datasets/locales:
    get:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Gets A List Of Supported Locales For Datasets'
      operationId: microsoftAzureGetsupportedlocalesfordatasets
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DatasetLocales'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get the supported locales:
          $ref: ./examples/get_supported_dataset_locales.json
      description: Needs a more full description created.
  /datasets:
    get:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Gets A List Of Datasets For The Authenticated Subscription'
      operationId: microsoftAzureGetdatasets
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Dataset'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all datasets:
          $ref: ./examples/get_datasets.json
      description: Needs a more full description created.
  /datasets/{id}:
    get:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Gets The Dataset Identified By The Given Id'
      operationId: microsoftAzureGetdataset
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the dataset.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Dataset'
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait for a non terminal
                operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get a dataset:
          $ref: ./examples/get_dataset.json
      description: Needs a more full description created.
    patch:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Updates The Mutable Details Of The Dataset Identified By Its Id'
      operationId: microsoftAzureUpdatedataset
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the dataset.
          required: true
          type: string
          format: uuid
        - in: body
          name: datasetUpdate
          description: The updated values for the dataset.
          required: true
          schema:
            $ref: '#/definitions/DatasetUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Dataset'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update a dataset:
          $ref: ./examples/update_dataset.json
      description: Needs a more full description created.
    delete:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Deletes The Specified Dataset'
      operationId: microsoftAzureDeletedataset
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the dataset.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The dataset was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete a dataset:
          $ref: ./examples/delete_dataset.json
      description: Needs a more full description created.
  /datasets/upload:
    post:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Uploads Data And Creates A New Dataset'
      operationId: microsoftAzureUploaddataset
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - in: formData
          name: name
          description: The name of this dataset (always add this string for any dataset).
          type: string
        - in: formData
          name: description
          description: Optional description of this dataset.
          type: string
        - in: formData
          name: locale
          description: The locale of this dataset (always add this string for any dataset).
          type: string
        - in: formData
          name: dataImportKind
          description: >-
            The kind of the dataset (always add this string for any dataset).
            Possible values are "Language", "Acoustic", "Pronunciation".
          type: string
        - in: formData
          name: properties
          description: >-
            Optional properties of this dataset (json serialized object with
            key/values, where all values must be strings)
          type: string
        - in: formData
          name: audiodata
          description: >-
            A zip file containing the audio data (this and the audio archive
            file for acoustic datasets).
          type: file
        - in: formData
          name: transcriptions
          description: >-
            A text file containing the transcriptions for the audio data (this
            and the transcriptions file for acoustic datasets).
          type: file
        - in: formData
          name: languagedata
          description: >-
            A text file containing the language or pronunciation data (only this
            file for language datasets).
          type: file
      responses:
        '202':
          description: >-
            The request was accepted and the response contains the location of
            the entity.
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait before accessing the
                resource created in this operation.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Upload a dataset:
          $ref: ./examples/upload_dataset.json
      description: Needs a more full description created.
  /endpoints/locales:
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets A List Of Supported Locales For Endpoint Creations'
      operationId: microsoftAzureGetsupportedlocalesforendpoints
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              type: string
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get the supported locales:
          $ref: ./examples/get_supported_endpoint_locales.json
      description: Needs a more full description created.
  /endpoints:
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets The List Of Endpoints For The Authenticated Subscription'
      operationId: microsoftAzureGetendpoints
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Endpoint'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all endpoints:
          $ref: ./examples/get_endpoints.json
      description: Needs a more full description created.
    post:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Creates A New Endpoint'
      operationId: microsoftAzureCreateendpoint
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: endpointDefinition
          description: The details of the endpoint.
          required: true
          schema:
            $ref: '#/definitions/SpeechEndpointDefinition'
      responses:
        '202':
          description: >-
            The request was accepted and the response contains the location of
            the entity.
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait before accessing the
                resource created in this operation.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create an endpoint:
          $ref: ./examples/create_endpoint.json
      description: Needs a more full description created.
  /endpoints/{id}:
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets The Endpoint Identified By The Given Id'
      operationId: microsoftAzureGetendpoint
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Endpoint'
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait for a non terminal
                operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get an endpoint:
          $ref: ./examples/get_endpoint.json
      description: Needs a more full description created.
    delete:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Deletes The Endpoint Identified By The Given Id'
      operationId: microsoftAzureDeleteendpoint
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The model endpoint was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete an endpoint:
          $ref: ./examples/delete_endpoint.json
      description: Needs a more full description created.
    patch:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Updates The Metadata Of The Endpoint Identified By The Given Id'
      operationId: microsoftAzureUpdateendpoint
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
        - in: body
          name: endpointUpdate
          description: The updated values for the endpoint.
          required: true
          schema:
            $ref: '#/definitions/EndpointMetadataUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Endpoint'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update an endpoint:
          $ref: ./examples/update_endpoint.json
      description: Needs a more full description created.
  /endpoints/{endpointId}/data:
    delete:
      tags:
        - 'Custom Speech Endpoints:'
      summary: >-
        Microsoft Azure Deletes The Transcriptions And Captured Audio Files Associated With The Endpoint Identified By The Given Id
      description: Deletion will happen in the background and can take up to a day.
      operationId: microsoftAzureDeleteendpointdata
      produces:
        - application/json
      parameters:
        - in: path
          name: endpointId
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The endpoint data export tasks were successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete the data for an endpoint:
          $ref: ./examples/delete_endpoint_data.json
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets The List Of Endpoint Data Export Tasks For The Authenticated User'
      operationId: microsoftAzureGetendpointdataexports
      produces:
        - application/json
      parameters:
        - in: path
          name: endpointId
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/EndpointData'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all endpoint data exports:
          $ref: ./examples/get_endpoint_data_exports.json
      description: Needs a more full description created.
    post:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Create A New Endpoint Data Export Task'
      operationId: microsoftAzureCreateendpointdataexport
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: endpointId
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
        - in: body
          name: endpointDataDefinition
          description: The details of the new endpoint data export.
          required: true
          schema:
            $ref: '#/definitions/EndpointDataDefinition'
      responses:
        '202':
          description: >-
            The response contains the id of the endpoint data export task in the
            header.
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait before accessing the
                resource created in this operation.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              type: integer
            X-RateLimit-Reset:
              description: >-
                The timestamp when the rate limit will be reset formatted as ISO
                8601 combined date and time in UTC.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Locatio

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/speech-services-api-v20-openapi-original.yml