---
title: "GET /models/{id}"
method: GET
path: "/models/{id}"
tags: ["Model"]
---

# GET /models/{id}

`GET /models/{id}`

Gets the model identified by the given ID.

## Path parameters

- `id` string, required

## Query parameters

- `api-version` string, required

## Response `200`

Success

- Model — Model object
  - `id` string — Resource id
  - `voiceName` string — Voice name
  - `description` string — Model description
  - `recipe` Recipe, required — Recipe for model building. Different recipes have different capability.
    - `kind` string — Recipe kind
    - `version` string — Recipe version
    - `description` string — Recipe description
    - `minUtteranceCount` integer — Minimum utterance count required to train a voice model with this recipe.
    - `minStyleUtteranceCount` integer — Minimum utterance count required to train each customized style.
    - `maxCustomStyleNum` integer — Maximum customized style number supported in one voice model.
    - `datasetLocales` string[] — The locale of the training dataset. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
    - `modelLocales` string[] — The locale that a voice model can speak with this recipe. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
    - `presetStyles` object — Preset styles supported by this recipe per locale. You can get these styles without any style training set.
  - `locale` string — The locale of this model. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
  - `projectId` string, required — Resource id
  - `consentId` string, required — Resource id
  - `trainingSetId` string, required — Resource id
  - `engineVersion` string — Engine version. Update this version can get the latest pronunciation bug fixing.
  - `properties` ModelProperties — Model properties
    - `presetStyles` string[] — Preset styles of this model.
    - `styleTrainingSetIds` object — Customized styles and associated training sets.
    - `voiceStyles` string[] — All styles supported by this model.
    - `failureReason` 'InaccessibleCustomerStorage' | 'SpeakerVerificationFailed' | 'TerminateByUser' | 'Internal' — Model training failure reason
  - `status` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Disabling' | 'Disabled' — Status of a resource.
  - `createdDateTime` string, date-time — The timestamp when the object was created. 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).
  - `lastActionDateTime` string, date-time — The timestamp when the current status was entered. 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).

## Other responses

- `default` — An error occurred.

---

[API](https://skmtc.net/azure/apis/cognitiveservices-speech-texttospeech.md) · [All operations](https://skmtc.net/azure/apis/cognitiveservices-speech-texttospeech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/cognitiveservices-speech-texttospeech/versions/ab0685f3cc0d/schema)