Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Base Models - List

Service:
Azure AI Services
API Version:
2026-01-01

Gets a list of base models.

GET {endpoint}/customvoice/basemodels?api-version=2026-01-01

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

Supported Cognitive Services endpoints (protocol and hostname, for example: https://eastus.api.cognitive.microsoft.com).
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

PagedBaseModel

The request has succeeded.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Get base models

Sample request

GET {endpoint}/customvoice/basemodels?api-version=2026-01-01

Sample response

Status code:
200 
{
 "value": [
 {
 "name": "PhoenixV2Neural",
 "description": "Phonenix V2 base model",
 "capabilities": [
 "PersonalVoice"
 ],
 "releaseDateTime": "2023-12-01T00:00:00.000Z"
 }
 ]
}

Definitions

Name Description
Azure.Core.Foundations.Error

The error object.
Azure.Core.Foundations.ErrorResponse

A response containing error details.
Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
BaseModel

Base model
ModelCapability

Model capability
PagedBaseModel

Paged collection of BaseModel items

Azure.Core.Foundations.Error

Object

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.
innererror

Azure.Core.Foundations.InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

Azure.Core.Foundations.InnerError

Inner error.

BaseModel

Object

Base model

Name Type Description
capabilities

ModelCapability[]

Capabilities of base model
description

string

Base model description
expirationDateTime

string (date-time)

The timestamp when TTS service will stop serving this base model. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
name

string

minLength: 1

Base model name
releaseDateTime

string (date-time)

The stamp when the base model was released. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

ModelCapability

Enumeration

Model capability

Value Description
PersonalVoice

PersonalVoice

PagedBaseModel

Object

Paged collection of BaseModel items

Name Type Description
nextLink

string (uri)

The link to the next page of items
value

BaseModel[]

The BaseModel items on this page