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  

Get list of Mix applications

GET /v4/apps

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  

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