Transcriptions - List Files

Reference

Service:: Azure AI Services

API Version:: 2024-11-15

Gets the files of the transcription identified by the given ID.

GET {endpoint}/speechtotext/transcriptions/{id}/files?api-version=2024-11-15

With optional parameters:

GET {endpoint}/speechtotext/transcriptions/{id}/files?sasLifetimeMinutes={sasLifetimeMinutes}&skip={skip}&top={top}&filter={filter}&api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	The identifier of the transcription.
api-version	query	True	string	The requested api version.
filter	query		string	A filtering expression for selecting a subset of the available files. `- Supported properties: name, createdDateTime, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=name eq 'myaudio.wav.json' and kind eq 'Transcription'`
sasLifetimeMinutes	query		integer int32	This parameter defines the duration in minutes for which an SAS url should be valid. `The parameter can only be used for operations on speech resources that don't have BYOS enabled and transcriptions without a destinationContainerUrl. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS and transcriptions with a destinationContainerUrl, returned urls do not contain an SAS token.`
skip	query		integer int32	Number of datasets that will be skipped.
top	query		integer int32	Number of datasets that will be included after skipping.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your cognitive services account key here.

Responses

Name	Type	Description
200 OK	PaginatedFiles	OK Headers Retry-After: integer
Other Status Codes	Error	An error occurred.

Name

Type

Description

200 OK

PaginatedFiles

Headers

Retry-After: integer

Other Status Codes

Error

An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services account key here.

Type: apiKey
In: header

Examples

Get all files

Get all transcription files the name of which starts with the specified string

Get all files

Sample request

HTTP

GET {endpoint}/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?sasLifetimeMinutes=360&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15

Sample response

Status code:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "mywavefile1.wav.json",
      "kind": "Transcription",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef?api-version=3.2",
      "name": "mywavefile2.wav.json",
      "kind": "Transcription",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2&api-version=2024-11-15"
}

Get all transcription files the name of which starts with the specified string

Sample request

HTTP

GET {endpoint}/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?sasLifetimeMinutes=360&skip=0&top=10&filter=name%20eq%20'mywavefile1.wav.json'&api-version=2024-11-15

Sample response

Status code:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "mywavefile1.wav.json",
      "kind": "Transcription",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ]
}

Definitions

Name	Description
DetailedErrorCode	DetailedErrorCode
Error	Error
ErrorCode	ErrorCode
File	File
FileKind	FileKind
FileLinks	FileLinks
FileProperties	FileProperties
InnerError	InnerError
PaginatedFiles	PaginatedFiles

DetailedErrorCode

Name	Type	Description
AudioLengthLimitExceeded	string	The audio file is longer than the maximum allowed duration.
BadChannelConfiguration	string	There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application.
DataImportFailed	string	Data import failed.
DeleteNotAllowed	string	Delete not allowed.
DeployNotAllowed	string	Deploy not allowed.
DeployingFailedModel	string	Deploying failed model.
EmptyAudioFile	string	The audio file is empty.
EmptyRequest	string	Empty Request.
EndpointCannotBeDefault	string	Endpoint cannot be default.
EndpointLoggingNotSupported	string	Endpoint logging not supported.
EndpointNotUpdatable	string	Endpoint not updatable.
EndpointWithoutLogging	string	Endpoint without logging.
ExceededNumberOfRecordingsUris	string	Exceeded number of recordings uris.
FailedDataset	string	Failed dataset.
Forbidden	string	Forbidden.
InUseViolation	string	In use violation.
InaccessibleCustomerStorage	string	Inaccessible customer storage.
InvalidAdaptationMapping	string	Invalid adaptation mapping.
InvalidAudioFormat	string	The format of input audio is not supported.
InvalidBaseModel	string	Invalid base model.
InvalidCallbackUri	string	Invalid callback uri.
InvalidChannelSpecification	string	The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.)
InvalidChannels	string	Invalid channels.
InvalidCollection	string	Invalid collection.
InvalidDataset	string	Invalid dataset.
InvalidDocument	string	Invalid Document.
InvalidDocumentBatch	string	Invalid Document Batch.
InvalidLocale	string	Invalid locale.
InvalidLogDate	string	Invalid log date.
InvalidLogEndTime	string	Invalid log end time.
InvalidLogId	string	Invalid log id.
InvalidLogStartTime	string	Invalid log start time.
InvalidModel	string	Invalid model.
InvalidModelUri	string	Invalid model uri.
InvalidParameter	string	Invalid parameter.
InvalidParameterValue	string	Invalid parameter value.
InvalidPayload	string	Invalid payload.
InvalidPermissions	string	Invalid permissions.
InvalidPrerequisite	string	Invalid prerequisite.
InvalidProductId	string	Invalid product id.
InvalidProject	string	Invalid project.
InvalidProjectKind	string	Invalid project kind.
InvalidRecordingsUri	string	Invalid recordings uri.
InvalidRequestBodyFormat	string	Invalid request body format.
InvalidSasValidityDuration	string	Invalid sas validity duration.
InvalidSkipTokenForLogs	string	Invalid skip token for logs.
InvalidSourceAzureResourceId	string	Invalid source Azure resource ID.
InvalidSubscription	string	Invalid subscription.
InvalidTest	string	Invalid test.
InvalidTimeToLive	string	Invalid time to live.
InvalidTopForLogs	string	Invalid top for logs.
InvalidTranscription	string	Invalid transcription.
InvalidWebHookEventKind	string	Invalid web hook event kind.
MissingInputRecords	string	Missing Input Records.
ModelCopyAuthorizationExpired	string	Expired ModelCopyAuthorization.
ModelDeploymentNotCompleteState	string	Model deployment not complete state.
ModelDeprecated	string	Model deprecated.
ModelExists	string	Model exists.
ModelMismatch	string	Model mismatch.
ModelNotDeployable	string	Model not deployable.
ModelVersionIncorrect	string	Model Version Incorrect.
MultipleLanguagesIdentified	string	Language Identification recognized multiple languages. No dominant language could be determined.
NoLanguageIdentified	string	Language Identification did not recognize any language.
NoUtf8WithBom	string	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Only one of urls or container or dataset.
ProjectGenderMismatch	string	Project gender mismatch.
QuotaViolation	string	Quota violation.
SingleDefaultEndpoint	string	Single default endpoint.
SkuLimitsExist	string	Sku limits exist.
SubscriptionNotFound	string	Subscription not found.
UnexpectedError	string	Unexpected error.
UnsupportedClassBasedAdaptation	string	Unsupported class based adaptation.
UnsupportedDelta	string	Unsupported delta.
UnsupportedDynamicConfiguration	string	Unsupported dynamic configuration.
UnsupportedFilter	string	Unsupported filter.
UnsupportedLanguageCode	string	Unsupported language code.
UnsupportedOrderBy	string	Unsupported order by.
UnsupportedPagination	string	Unsupported pagination.
UnsupportedTimeRange	string	Unsupported time range.

Error

Name	Type	Description
code	ErrorCode	ErrorCode High level error codes.
details	Error[]	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

ErrorCode

Name	Type	Description
Conflict	string	Representing the conflict error code.
Forbidden	string	Representing the forbidden error code.
InternalCommunicationFailed	string	Representing the internal communication failed error code.
InternalServerError	string	Representing the internal server error error code.
InvalidArgument	string	Representing the invalid argument error code.
InvalidRequest	string	Representing the invalid request error code.
NotAllowed	string	Representing the not allowed error code.
NotFound	string	Representing the not found error code.
PipelineError	string	Representing the pipeline error error code.
ServiceUnavailable	string	Representing the service unavailable error code.
TooManyRequests	string	Representing the too many requests error code.
Unauthorized	string	Representing the unauthorized error code.
UnprocessableEntity	string	Representing the unprocessable entity error code.
UnsupportedMediaType	string	Representing the unsupported media type error code.

File

Name	Type	Description
createdDateTime	string	The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind	FileKind	FileKind Type of data.
links	FileLinks	FileLinks
name	string	The name of this file.
properties	FileProperties	FileProperties
self	string	The location of this entity.

FileKind

Name	Type	Description
AcousticDataArchive	string	Type of data is acoustic data archive.
AcousticDataTranscriptionV2	string	Type of data is acoustic data transcription v2.
Audio	string	Type of data is audio.
DatasetReport	string	Type of data is dataset report.
EvaluationDetails	string	Type of data is evaluation details.
LanguageData	string	Type of data is language data.
ModelReport	string	Type of data is model report.
OutputFormattingData	string	Type of data is output formatting input file.
PronunciationData	string	Type of data is pronunciation data.
Transcription	string	Type of data is transcription.
TranscriptionReport	string	Type of data is transcription report.

FileLinks

Name	Type	Description
contentUrl	string	The url to retrieve the content of this file.

FileProperties

Name	Type	Default value	Description
durationMilliseconds	integer	0	The total duration in milliseconds of the file in case this file is an audio file.
size	integer		The size of the data in bytes.

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Detailed error code enum.
details	object	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

PaginatedFiles

Name	Type	Description
@nextLink	string	A link to the next set of paginated results if there are more entities available; otherwise null.
values	File[]	A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list.

Name

Type

Description

@nextLink

string

A link to the next set of paginated results if there are more entities available; otherwise null.

values

File[]

A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.

When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list.

Share via

Transcriptions - List Files

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

Examples

Get all files

Sample request

Sample response

Get all transcription files the name of which starts with the specified string

Sample request

Sample response

Definitions

DetailedErrorCode

Error

ErrorCode

File

FileKind

FileLinks

FileProperties

InnerError

PaginatedFiles

Additional resources