Applications
A Mix application defines a set of credentials that you use to access Mix.asr, Mix.nlu, and/or Mix.dialog resources. A Mix application can be deployed to multiple runtime environments (for example, sandbox, QA, production, etc.).
An app ID uniquely identifies a Mix application in an environment. It is used to reference the resources created and managed in Mix.
Get list of Mix applications for an organization
GET /v4/organizations/{orgId}/apps
Retrieve the list of Mix applications available in the organization specified.
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
List of applications |
mix.api.ListApplicationsResponse |
| 401 |
Unauthorized |
Request could not be authorized |
Inline |
| 404 |
Not Found |
No content found |
Inline |
| 500 |
Internal Server Error |
Internal server error |
Inline |
| default |
Default |
An unexpected error response. |
grpc.gateway.runtime.Error |
Example responses
200 response
{
"applications": [
{
"id": "48",
"applicationName": "Mix Sample App",
"configs": [
{
"id": "180",
"tag": "MyCoffeeApp",
"deployments": [
{
"id": "57",
"status": "DEPLOYED",
"envGeographyDeployments": [
{
"id": "170",
"envGeography": {
"id": "57",
"geography": {
"id": "1",
"displayName": "Azure East US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
},
"status": "STATUS_UNSPECIFIED",
"deploymentResult": "n/a",
"isOverridden": true
}
]
}
],
"parentId": "179",
"deploymentFlowId": 57,
"builds": {
"asr": {
"builds": [
{
"locale": "en-US",
"buildVersion": "3",
"buildLabel": "ASR_525_3",
"createTime": "2019-10-24T15:44:38.097Z"
}
],
"projectId": "525"
},
"nlu": {
"builds": [
{
"locale": "en-US",
"buildVersion": "3",
"buildLabel": "NLU_525_3",
"createTime": "2019-10-24T15:44:34.333Z"
}
],
"projectId": "525"
},
"dialog": {
"projectId": "525",
"buildVersion": "2",
"buildLabel": "DIALOG_525_2",
"createTime": "2019-10-24T16:26:50.750Z"
}
},
"createTime": "2019-10-24T16:27:20.473Z"
}
],
"createTime": "2020-12-10T19:00:27.226Z"
}
],
"totalSize": 1
}
Get list of Mix applications
Retrieve the list of Mix applications.
Nuance Professional Services and global admin users can retrieve the list of Mix applications in all organizations. Other users must specify an organization to which they have access.
You can limit the number of results returned and use an offset to determine the starting position of results returned.
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
List of applications |
mix.api.v2.ListApplicationsResponse |
| 401 |
Unauthorized |
Request could not be authorized |
Inline |
| 404 |
Not Found |
No content found |
Inline |
| 500 |
Internal Server Error |
Internal server error |
Inline |
| default |
Default |
An unexpected error response. |
grpc.gateway.runtime.Error |
Example responses
200 response
{
"applications": [
{
"id": "48",
"applicationName": "Mix Sample App",
"organizationId": "3",
"organizationName": "json.smith@nuance.com",
"configs": [
{
"id": "180",
"tag": "MyCoffeeApp",
"deployments": [
{
"id": "57",
"status": "DEPLOYED",
"envGeographyDeployments": [
{
"id": "170",
"envGeography": {
"id": "57",
"geography": {
"id": "1",
"displayName": "Azure East US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
},
"status": "STATUS_UNSPECIFIED",
"deploymentResult": "n/a",
"isOverridden": true
}
]
}
],
"parentId": "179",
"deploymentFlowId": 57,
"builds": {
"asr": {
"builds": [
{
"locale": "en-US",
"buildVersion": "3",
"buildLabel": "ASR_525_3",
"createTime": "2019-10-24T15:44:38.097Z"
}
],
"projectId": "525"
},
"nlu": {
"builds": [
{
"locale": "en-US",
"buildVersion": "3",
"buildLabel": "NLU_525_3",
"createTime": "2019-10-24T15:44:34.333Z"
}
],
"projectId": "525"
},
"dialog": {
"projectId": "525",
"buildVersion": "2",
"buildLabel": "DIALOG_525_2",
"createTime": "2019-10-24T16:26:50.750Z"
}
},
"createTime": "2019-10-24T16:27:20.473Z"
}
],
"createTime": "2020-12-10T19:00:27.226Z"
}
],
"count": 1,
"totalSize": 5,
"limit": 1,
"offset": 0
}
Get application credentials
GET /v4/apps/{applicationId}/credentials
Retrieve the list of application credentials that correspond to the query criteria specified.
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
List of application credentials |
mix.api.ListApplicationCredentialsResponse |
| 401 |
Unauthorized |
Request could not be authorized |
Inline |
| 404 |
Not Found |
No content found |
Inline |
| 500 |
Internal Server Error |
Internal server error |
Inline |
| default |
Default |
An unexpected error response. |
grpc.gateway.runtime.Error |
Example responses
200 response
{
"credentials": [
{
"id": "35",
"credential": {
"id": "35",
"appId": "NMDPTRIAL_alex_smith_company_com_20200116T154425699927",
"clients": [
{
"id": "26",
"clientId": "appID:NMDPTRIAL_alex_smith_company_com_20200116T154425699927",
"clientName": "default",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2020-01-16T15:44:25.803Z",
"updateTime": "2020-02-06T17:15:36.682Z"
},
{
"id": "452",
"clientId": "appID:NMDPTRIAL_alex_smith_company_com_20200116T154425699927:geo:dev:clientName:mdc_dev",
"clientName": "mdc_dev",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2020-10-23T02:45:00.585Z",
"updateTime": "2020-10-23T02:45:00.694Z"
}
],
"createTime": "2020-01-16T15:44:25.803Z",
"updateTime": "2020-02-06T17:15:36.682Z"
},
"geographies": [
{
"id": "37",
"geography": {
"id": "1",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
],
"createTime": "2020-01-16T15:44:26.008Z",
"updateTime": "2020-10-23T02:44:57.157Z"
}
]
}