Models - Get File

Service:
Azure AI Services
API Version:
2025-10-15

Gets one specific file (identified with fileId) from a model (identified with id).

GET {endpoint}/speechtotext/models/{id}/files/{fileId}?api-version=2025-10-15
With optional parameters: 
GET {endpoint}/speechtotext/models/{id}/files/{fileId}?sasLifetimeMinutes={sasLifetimeMinutes}&api-version=2025-10-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).
fileId
 path True

string (uuid)

The identifier of the file.
id
 path True

string (uuid)

The identifier of the model.
api-version
 query True

string

The requested api version.
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. For speech resources

        that don't have BYOS enabled, the default SAS validity duration is 12 hours.

        For speech resources with BYOS, returned urls do not contain an SAS token.

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

File

OK
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 a file

Sample request

GET {endpoint}/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?sasLifetimeMinutes=360&api-version=2025-10-15

Sample response

Status code:
200 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
  "name": "report.json",
  "kind": "ModelReport",
  "links": {
    "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.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

DetailedErrorCode

Enumeration

DetailedErrorCode

Value Description
InvalidParameterValue

Invalid parameter value.
InvalidRequestBodyFormat

Invalid request body format.
EmptyRequest

Empty Request.
MissingInputRecords

Missing Input Records.
InvalidDocument

Invalid Document.
ModelVersionIncorrect

Model Version Incorrect.
InvalidDocumentBatch

Invalid Document Batch.
UnsupportedLanguageCode

Unsupported language code.
DataImportFailed

Data import failed.
InUseViolation

In use violation.
InvalidLocale

Invalid locale.
InvalidBaseModel

Invalid base model.
InvalidAdaptationMapping

Invalid adaptation mapping.
InvalidDataset

Invalid dataset.
InvalidTest

Invalid test.
FailedDataset

Failed dataset.
InvalidModel

Invalid model.
InvalidTranscription

Invalid transcription.
InvalidPayload

Invalid payload.
InvalidParameter

Invalid parameter.
EndpointWithoutLogging

Endpoint without logging.
InvalidPermissions

Invalid permissions.
InvalidPrerequisite

Invalid prerequisite.
InvalidProductId

Invalid product id.
InvalidSubscription

Invalid subscription.
InvalidProject

Invalid project.
InvalidProjectKind

Invalid project kind.
InvalidRecordingsUri

Invalid recordings uri.
OnlyOneOfUrlsOrContainerOrDataset

Only one of urls or container or dataset.
ExceededNumberOfRecordingsUris

Exceeded number of recordings uris.
InvalidChannels

Invalid channels.
ModelMismatch

Model mismatch.
ProjectGenderMismatch

Project gender mismatch.
ModelDeprecated

Model deprecated.
ModelExists

Model exists.
ModelNotDeployable

Model not deployable.
EndpointNotUpdatable

Endpoint not updatable.
SingleDefaultEndpoint

Single default endpoint.
EndpointCannotBeDefault

Endpoint cannot be default.
InvalidModelUri

Invalid model uri.
SubscriptionNotFound

Subscription not found.
QuotaViolation

Quota violation.
UnsupportedDelta

Unsupported delta.
UnsupportedFilter

Unsupported filter.
UnsupportedPagination

Unsupported pagination.
UnsupportedDynamicConfiguration

Unsupported dynamic configuration.
UnsupportedOrderBy

Unsupported order by.
NoUtf8WithBom

No utf8 with bom.
ModelDeploymentNotCompleteState

Model deployment not complete state.
SkuLimitsExist

Sku limits exist.
DeployingFailedModel

Deploying failed model.
UnsupportedTimeRange

Unsupported time range.
InvalidLogDate

Invalid log date.
InvalidLogId

Invalid log id.
InvalidLogStartTime

Invalid log start time.
InvalidLogEndTime

Invalid log end time.
InvalidTopForLogs

Invalid top for logs.
InvalidSkipTokenForLogs

Invalid skip token for logs.
DeleteNotAllowed

Delete not allowed.
Forbidden

Forbidden.
DeployNotAllowed

Deploy not allowed.
UnexpectedError

Unexpected error.
InvalidCollection

Invalid collection.
InvalidCallbackUri

Invalid callback uri.
InvalidSasValidityDuration

Invalid sas validity duration.
InaccessibleCustomerStorage

Inaccessible customer storage.
UnsupportedClassBasedAdaptation

Unsupported class based adaptation.
InvalidWebHookEventKind

Invalid web hook event kind.
InvalidTimeToLive

Invalid time to live.
InvalidSourceAzureResourceId

Invalid source Azure resource ID.
ModelCopyAuthorizationExpired

Expired ModelCopyAuthorization.
EndpointLoggingNotSupported

Endpoint logging not supported.
NoLanguageIdentified

Language Identification did not recognize any language.
MultipleLanguagesIdentified

Language Identification recognized multiple languages. No dominant language could be determined.
InvalidAudioFormat

The format of input audio is not supported.
BadChannelConfiguration

There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application.
InvalidChannelSpecification

The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.)
AudioLengthLimitExceeded

The audio file is longer than the maximum allowed duration.
EmptyAudioFile

The audio file is empty.

Error

Object

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

Enumeration

ErrorCode

Value Description
InvalidRequest

Representing the invalid request error code.
InvalidArgument

Representing the invalid argument error code.
InternalServerError

Representing the internal server error error code.
ServiceUnavailable

Representing the service unavailable error code.
NotFound

Representing the not found error code.
PipelineError

Representing the pipeline error error code.
Conflict

Representing the conflict error code.
InternalCommunicationFailed

Representing the internal communication failed error code.
Forbidden

Representing the forbidden error code.
NotAllowed

Representing the not allowed error code.
Unauthorized

Representing the unauthorized error code.
UnsupportedMediaType

Representing the unsupported media type error code.
TooManyRequests

Representing the too many requests error code.
UnprocessableEntity

Representing the unprocessable entity error code.

File

Object

File

Name Type Description
createdDateTime

string (date-time)

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 (uri)

The location of this entity.

FileKind

Enumeration

FileKind

Value Description
DatasetReport

Type of data is dataset report.
Audio

Type of data is audio.
LanguageData

Type of data is language data.
PronunciationData

Type of data is pronunciation data.
AcousticDataArchive

Type of data is acoustic data archive.
AcousticDataTranscriptionV2

Type of data is acoustic data transcription v2.
Transcription

Type of data is transcription.
TranscriptionReport

Type of data is transcription report.
EvaluationDetails

Type of data is evaluation details.
ModelReport

Type of data is model report.
OutputFormattingData

Type of data is output formatting input file.
Object

FileLinks

Name Type Description
contentUrl

string (uri)

The url to retrieve the content of this file.

FileProperties

Object

FileProperties

Name Type Default value Description
durationMilliseconds

integer (int32)

0

The total duration in milliseconds of the file in case this file is an audio file.
size

integer (int64)

The size of the data in bytes.

InnerError

Object

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.