The Microsoft Azure Speech Services API V3.0 is a powerful and versatile tool that allows developers to incorporate speech recognition and translation capabilities into their applications. With this API, users can easily transcribe spoken language into text, identify spoken language, convert text into natural sounding speech, and translate spoken language into different languages.
swagger: '2.0'
info:
title: Microsoft Azure Speech Services API v3.0
description: Speech Services API v3.0.
contact:
name: Cognitive Services - Speech Services
url: https://docs.microsoft.com/azure/cognitive-services/speech-service/support
version: v3.0
paths:
/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'
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
parameters:
- $ref: '#/parameters/skipQueryParameter'
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedDatasets'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all datasets:
$ref: ./examples/get_datasets.json
description: Needs a more full description created.
post:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: >-
Microsoft Azure Uploads And Creates A New Dataset By Getting The Data From A Specified Url
operationId: microsoftAzureCreatedataset
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: dataset
description: Definition for the new dataset.
required: true
schema:
$ref: '#/definitions/Dataset'
responses:
'201':
description: >-
The response contains information about the entity as payload and
its location as header.
schema:
$ref: '#/definitions/Dataset'
headers:
Location:
description: The location of the created resource.
type: string
format: uri
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Create a dataset:
$ref: ./examples/create_dataset.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
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
- application/merge-patch+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:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
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 or did not exist.
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: microsoftAzureUploaddatasetfromform
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- in: formData
name: project
description: >-
The optional string representation of the url of a project. If set,
the dataset will be associated with that project.
type: string
- in: formData
name: displayName
description: The name of this dataset (required).
required: true
type: string
- in: formData
name: description
description: Optional description of this dataset.
type: string
- in: formData
name: locale
description: The locale of this dataset (required).
required: true
type: string
- in: formData
name: kind
description: >-
The kind of the dataset (required). Possible values are "Language",
"Acoustic", "Pronunciation", "AudioFiles".
required: true
type: string
- in: formData
name: customProperties
description: >-
The optional custom properties of this entity. The maximum allowed
key length is 64 characters, the maximum allowed value length is 256
characters and the count of allowed entries is 10.
type: string
- in: formData
name: data
description: >-
For acoustic datasets, a zip file containing the audio data and a
text file containing the transcriptions for the audio data. For
language datasets, a text file containing the language or
pronunciation data. Required in both cases.
type: file
- in: formData
name: email
description: >-
An optional string containing the email address to send email
notifications to in case the operation completes. The value will be
removed after successfully sending the email.
type: string
responses:
'201':
description: >-
The response contains information about the entity as payload and
its location as header.
schema:
$ref: '#/definitions/Dataset'
headers:
Location:
description: The location of the created resource.
type: string
format: uri
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
deprecated: true
x-ms-examples:
Upload a dataset:
$ref: ./examples/upload_dataset.json
description: Needs a more full description created.
/datasets/{id}/files:
get:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: 'Microsoft Azure Gets The Files Of The Dataset Identified By The Given Id'
operationId: microsoftAzureGetdatasetfiles
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
- $ref: '#/parameters/sasValidityQueryParameter'
- $ref: '#/parameters/skipQueryParameter'
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedFiles'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all files:
$ref: ./examples/get_dataset_files.json
description: Needs a more full description created.
/datasets/{id}/files/{fileId}:
get:
tags:
- 'Custom Speech Datasets for Model Adaptation:'
summary: >-
Microsoft Azure Gets One Specific File Identified With Fileid From A Dataset Identified With Id
operationId: microsoftAzureGetdatasetfile
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the dataset.
required: true
type: string
format: uuid
- in: path
name: fileId
description: The identifier of the file.
required: true
type: string
format: uuid
- $ref: '#/parameters/sasValidityQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/File'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get a file:
$ref: ./examples/get_dataset_file.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
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
parameters:
- $ref: '#/parameters/skipQueryParameter'
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedEndpoints'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
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: endpoint
description: The details of the endpoint.
required: true
schema:
$ref: '#/definitions/Endpoint'
responses:
'201':
description: >-
The response contains information about the entity as payload and
its location as header.
schema:
$ref: '#/definitions/Endpoint'
headers:
Location:
description: The location of the created resource.
type: string
format: uri
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
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
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.
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
- application/merge-patch+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/EndpointUpdate'
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
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/{id}/files/logs:
get:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Gets The List Of Audio And Transcription Logs That Have Been Stored For A Given Endpoint
operationId: microsoftAzureGetendpointlogs
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- $ref: '#/parameters/sasValidityQueryParameter'
- in: query
name: skipToken
description: >-
Token to skip logs that were already retrieved in previous requests.
Pagination starts from beginning when not defined.
type: string
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedFiles'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all endpoint logs:
$ref: ./examples/get_endpoint_logs.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Deletes The Specified Audio And Transcription Logs That Have Been Stored For A Given Endpoint It Deletes All Logs Before And Including A Specific Day
description: >-
The deletion process is done asynchronously and can take up to one day
depending on the amount of log files.
operationId: microsoftAzureDeleteendpointlogs
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- in: query
name: endDate
description: "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n Deletes all existing logs when date is not specified."
type: string
responses:
'202':
description: The logs will be deleted.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete all endpoint logs:
$ref: ./examples/delete_endpoint_logs.json
/endpoints/{id}/files/logs/{logId}:
get:
tags:
- 'Custom Speech Endpoints:'
summary: 'Microsoft Azure Gets A Specific Audio Or Transcription Log For A Given Endpoint'
operationId: microsoftAzureGetendpointlog
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- in: path
name: logId
description: The identifier of the log.
required: true
type: string
- $ref: '#/parameters/sasValidityQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/File'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get an endpoint log:
$ref: ./examples/get_endpoint_log.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Deletes One Audio Or Transcription Log That Have Been Stored For A Given Endpoint
operationId: microsoftAzureDeleteendpointlog
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the endpoint.
required: true
type: string
format: uuid
- in: path
name: logId
description: The identifier of the log.
required: true
type: string
responses:
'204':
description: The log was successfully deleted.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete an endpoint log:
$ref: ./examples/delete_endpoint_log.json
description: Needs a more full description created.
/endpoints/base/{locale}/files/logs:
get:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Gets The List Of Audio And Transcription Logs That Have Been Stored When Using The Default Base Model Of A Given Language
operationId: microsoftAzureGetbasemodellogs
produces:
- application/json
parameters:
- in: path
name: locale
description: The language used to select the default base model.
required: true
type: string
- $ref: '#/parameters/sasValidityQueryParameter'
- in: query
name: skipToken
description: >-
Token to skip logs that were already retrieved in previous requests.
Pagination starts from beginning when not defined.
type: string
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedFiles'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all base model logs:
$ref: ./examples/get_base_model_logs.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Deletes The Specified Audio And Transcription Logs That Have Been Stored When Using The Default Base Model Of A Given Language It Deletes All Logs Before And Including A Specific Day
description: >-
Deletion process is done asynchronously and can take up to one day
depending on the amount of log files.
operationId: microsoftAzureDeletebasemodellogs
produces:
- application/json
parameters:
- in: path
name: locale
description: The language used to select the default base model.
required: true
type: string
- in: query
name: endDate
description: "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n Deletes all existing logs when date is not specified."
type: string
responses:
'202':
description: The logs will be deleted.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete all base model logs:
$ref: ./examples/delete_base_model_logs.json
/endpoints/base/{locale}/files/logs/{logId}:
get:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Gets A Specific Audio Or Transcription Log For The Default Base Model In A Given Language
operationId: microsoftAzureGetbasemodellog
produces:
- application/json
parameters:
- in: path
name: locale
description: The language used to select the default base model.
required: true
type: string
- in: path
name: logId
description: The identifier of the log.
required: true
type: string
- $ref: '#/parameters/sasValidityQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/File'
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get a base model log:
$ref: ./examples/get_base_model_log.json
description: Needs a more full description created.
delete:
tags:
- 'Custom Speech Endpoints:'
summary: >-
Microsoft Azure Deletes One Audio Or Transcription Log That Have Been Stored When Using The Default Base Model Of A Given Language
operationId: microsoftAzureDeletebasemodellog
produces:
- application/json
parameters:
- in: path
name: locale
description: The language used to select the default base model.
required: true
type: string
- in: path
name: logId
description: The identifier of the log.
required: true
type: string
responses:
'204':
description: The log was successfully deleted.
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Delete a base model log:
$ref: ./examples/delete_base_model_log.json
description: Needs a more full description created.
/evaluations/locales:
get:
tags:
- 'Custom Speech Model Evaluations:'
summary: 'Microsoft Azure Gets A List Of Supported Locales For Evaluations'
operationId: microsoftAzureGetsupportedlocalesforevaluations
produces:
- application/json
responses:
'200':
description: OK
schema:
type: array
items:
type: string
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Get the supported locales:
$ref: ./examples/get_supported_evaluations_locales.json
description: Needs a more full description created.
/evaluations:
get:
tags:
- 'Custom Speech Model Evaluations:'
summary: 'Microsoft Azure Gets The List Of Evaluations For The Authenticated Subscription'
operationId: microsoftAzureGetevaluations
produces:
- application/json
parameters:
- $ref: '#/parameters/skipQueryParameter'
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedEvaluations'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all evaluations:
$ref: ./examples/get_evaluations.json
description: Needs a more full description created.
post:
tags:
- 'Custom Speech Model Evaluations:'
summary: 'Microsoft Azure Creates A New Evaluation'
operationId: microsoftAzureCreateevaluation
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: evaluation
description: The details of the new evaluation.
required: true
schema:
$ref: '#/definitions/Evaluation'
responses:
'201':
description: >-
The response contains information about the entity as payload and
its location as header.
schema:
$ref: '#/definitions/Evaluation'
headers:
Location:
description: The location of the created resource.
type: string
format: uri
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-examples:
Create a evaluation:
$ref: ./examples/create_evaluation.json
description: Needs a more full description created.
/evaluations/{id}/files:
get:
tags:
- 'Custom Speech Model Evaluations:'
summary: 'Microsoft Azure Gets The Files Of The Evaluation Identified By The Given Id'
operationId: microsoftAzureGetevaluationfiles
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the evaluation.
required: true
type: string
format: uuid
- $ref: '#/parameters/sasValidityQueryParameter'
- $ref: '#/parameters/skipQueryParameter'
- $ref: '#/parameters/topQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PaginatedFiles'
headers:
Retry-After:
description: >-
The minimum number of seconds to wait for a non terminal
operation to complete.
type: integer
default:
description: An error occurred.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
itemName: values
nextLinkName: '@nextLink'
x-ms-examples:
Get all files:
$ref: ./examples/get_evaluation_files.json
description: Needs a more full description created.
/evaluations/{id}/files/{fileId}:
get:
tags:
- 'Custom Speech Model Evaluations:'
summary: >-
Microsoft Azure Gets One Specific File Identified With Fileid From An Evaluation Identified With Id
operationId: microsoftAzureGetevaluationfile
produces:
- application/json
parameters:
- in: path
name: id
description: The identifier of the evaluation.
required: true
type: string
format: uuid
- in: path
name: fileId
description: The identifier of the file.
required: true
type: string
format: uuid
- $ref: '#/parameters/sasValidityQueryParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/File'
default:
description: An error occurred.
schema:
$ref: '#/d
# --- truncated at 32 KB (137 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/speech-services-api-v30-openapi-original.yml