Apps - List Cortana Endpoints

Service:

Cognitive Services - LUIS

API Version:

2.0

Gets the endpoint URLs for the prebuilt Cortana applications.

GET {Endpoint}/luis/api/v2.0/apps/assistants

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).

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Responses

Name	Type	Description
200 OK	PersonalAssistantsResponse	A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Personal Assistant Applications

Sample Request

HTTP

GET {Endpoint}/luis/api/v2.0/apps/assistants

Sample Response

Status code:

200

{
  "endpointKeys": [],
  "endpointUrls": {
    "English": "EnglishDummyURL",
    "Chinese": "ChineseDummyURL",
    "French": "FrenchDummyURL",
    "Spanish": "SpanishDummyURL",
    "Italian": "ItalianDummyURL"
  }
}

Definitions

Name	Description
ErrorResponse	Error response when invoking an operation on the API.
PersonalAssistantsResponse	Response containing user's endpoint keys and the endpoint URLs of the prebuilt Cortana applications.

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

PersonalAssistantsResponse

Response containing user's endpoint keys and the endpoint URLs of the prebuilt Cortana applications.

Name	Type	Description
endpointKeys	string[]	An a array of GUIDs, comprised of Azure Endpoint Keys and the Authoring API key.
endpointUrls	object	Endpoint URLs for prebuilt Cortana applications.