Endpoints - List

Service:: Azure AI Services

API Version:: 2024-02-01-preview

Gets a list of endpoints for the authenticated Speech service resource.

GET {endpoint}/customvoice/endpoints?api-version=2024-02-01-preview

With optional parameters:

GET {endpoint}/customvoice/endpoints?skip={skip}&maxpagesize={maxpagesize}&filter={filter}&api-version=2024-02-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	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.
filter	query		string	Filter condition. Supported properties: projectId, createdDateTime, locale, kind Operators: eq, ne are supported for all properties. gt, ge, lt, le are supported for createdDateTime. Example: `filter=projectId eq 'Jessica'` (filter by project ID) `filter=kind eq 'ProfessionalVoice'` (filter project by kind) `filter=locale eq 'en-US'` (filter training set and model by locale) `filter=createdDateTime gt 2022-12-30T23:59:59.99Z` (filter resource created time after 2023-11-01)
maxpagesize	query		integer (int32)	The maximum number of items to include in a single response.
skip	query		integer (int32)	The number of result items to skip.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your Speech resource key here.

Responses

Name	Type	Description
200 OK	PaginatedEndpoints	Success
Other Status Codes	ErrorResponse	An error occurred. Headers x-ms-error-code: string

Name

Type

Description

200 OK

PaginatedEndpoints

Success

Other Status Codes

ErrorResponse

An error occurred.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Provide your Speech resource key here.

Type: apiKey
In: header

Examples

Get all endpoints

Sample request

HTTP

GET {endpoint}/customvoice/endpoints?api-version=2024-02-01-preview

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
      "description": "Endpoint for Jessica voice",
      "projectId": "Jessica",
      "modelId": "Jessica",
      "properties": {
        "kind": "HighPerformance"
      },
      "status": "NotStarted",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-02T10:15:30.000Z"
    },
    {
      "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
      "description": "Endpoint for Jessica voice",
      "projectId": "Jessica",
      "modelId": "Jessica",
      "properties": {
        "kind": "HighPerformance"
      },
      "status": "NotStarted",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-02T10:15:30.000Z"
    }
  ],
  "nextLink": "https://eastus.api.cognitive.microsoft.com/customvoice/endpoints?skip=2&maxpagesize=2&api-version=2024-02-01-preview"
}

Definitions

Name	Description
Endpoint	Endpoint object
EndpointKind	Endpoint kind
EndpointProperties	Endpoint properties
Error	Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.
ErrorCode	Top-level error code
ErrorResponse	Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
PaginatedEndpoints	Paginated endpoint list
Status	Status of a resource.

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
FastResume

EndpointProperties

Object

Endpoint properties

Name	Type	Description
kind	EndpointKind	Endpoint kind

Error

Object

Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.

Name	Type	Description
code	ErrorCode	Top-level error code
details	Error[]	Additional supportive details regarding the error and/or expected policies.
innererror	InnerError	Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
message	string	Top-level error message.
target	string	The source of the error. For example it would be "model" or "model id" in case of invalid model.

ErrorCode

Enumeration

Top-level error code

Value	Description
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
error	Error	Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.

InnerError

Object

Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).

Name	Type	Description
code	string	Detailed error code to help diagnostic.
innererror	InnerError	Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
message	string	Detailed error message.
target	string	The source of the error. For example it would be "model" or "model id" in case of invalid model.

PaginatedEndpoints

Object

Paginated endpoint list

Name	Type	Description
nextLink	string (uri)	Link to next page.
value	Endpoint[]	Endpoint list

Status

Enumeration

Status of a resource.

Value	Description
NotStarted
Running
Succeeded
Failed
Disabling
Disabled

Share via

Endpoints - List

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

Examples

Get all endpoints

Sample request

Sample response

Definitions

Endpoint

EndpointKind

EndpointProperties

Error

ErrorCode

ErrorResponse

InnerError

PaginatedEndpoints

Status