Endpoints - Get

Service:: Azure AI Services

API Version:: 2026-01-01

Gets the endpoint identified by the given ID.

GET {endpoint}/customvoice/endpoints/{id}?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).
id	path	True	string (uuid)	Endpoint Id
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Endpoint	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

Endpoint

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 an endpoint

Sample request

HTTP

GET {endpoint}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb?api-version=2026-01-01

Sample response

Status code:: 200

{
  "description": "Endpoint for Jessica voice",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z",
  "modelId": "Jessica",
  "projectId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "NotStarted"
}

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.
Endpoint	Endpoint object
EndpointKind	Endpoint kind
EndpointProperties	Endpoint properties
Status	Status of a resource.

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.

Endpoint

Object

Endpoint object

Name	Type	Description
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).
description	string	Endpoint description
displayName	string minLength: 1	Endpoint name
id	string (uuid)	Endpoint Id
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).
modelId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource id
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource id
properties	EndpointProperties	Endpoint properties
status	Status	Status of a resource.

EndpointKind

Enumeration

Endpoint kind

Value	Description
HighPerformance	HighPerformance
FastResume	FastResume

EndpointProperties

Object

Endpoint properties

Name	Type	Description
kind	EndpointKind	Endpoint kind

Status

Enumeration

Status of a resource.

Value	Description
NotStarted	NotStarted
Running	Running
Succeeded	Succeeded
Failed	Failed
Disabling	Disabling
Disabled	Disabled