Mix.api

Nuance Mix.api is an interface that lets you interact with the Nuance® Mix Platform to perform authoring, deployment, and management tasks.

You can use the API to develop custom workflows that fit the needs of your applications.

Version: v4

This document covers v4 of Mix.api.

URLs

• Mix.api: https://mix.api.nuance.co.uk/v4
• Swagger reference: https://mix.api.nuance.co.uk/v4/swagger-ui/index.html

Note: To use the Mix.api endpoints directly from the Swagger documentation, see Set up authorization for the Swagger documentation.

Authorization

Mix.api uses OAuth 2.0 for authorization. Two authorization flows are available and should be applied according to your use case:

• Client Credentials for machine-to-machine authorization: To communicate with Mix.api without manual intervention for user authorization, Nuance Mix requires a user with a service account to implement the Client Credentials flow. This flow must be enabled by your Nuance representative. Once a service account is enabled by Nuance, the client application obtains an access token by sending a client ID and a client secret. See Service account: OAuth 2.0 Client Credentials flow
• Authorization code: To communicate with Mix.api on behalf of an end user—for example, through a service-side web application—use the OAuth 2.0 Authorization Code grant type flow. In this authorization flow, the client application obtains an access token by asking the user to authorize the app. It differs from the Client Credentials authorization flow in that it requires the client application to launch a browser to begin the flow and requires the user to authorize the client application, providing additional validation. This flow is enabled for all users. See OAuth 2.0 Authorization Code flow.

Note: When using a REST API, specify the access token as a bearer token in the request header.

Service account: OAuth 2.0 Client Credentials flow

Use the service account and OAuth 2.0 Client Credentials flow for machine-to-machine communication, such as running offline Mix.api scripts.

The OAuth 2.0 Client Credentials grant type flow works as follows:

1. The client application requests an access token from the Nuance authorization server, providing the service credentials (client ID and client secret) using the HTTP Basic authentication scheme.
   
2. The Nuance authorization server generates and returns the access token.
3. The client application sends a Mix.api request, providing the access token.

Implement the Client Credentials flow in your client application

To enable authorization in your client application:

1. Obtain a service account.
2. Generate service credentials.
3. Request an access token.
4. Specify the access token in the client application.

Obtain a service account

Access to the OAuth 2.0 Client Credentials flow must be enabled by Nuance. Please contact your Nuance representative to obtain a service account.

Nuance recommends that you create a single user—for example, service_user@organization.com—to manage service credentials. The following section provides suggestions on managing and using this account in your organization.

Service credentials sample implementation

Sign up to Mix and create a single service account—for example, service_user@organization.com—with a functioning email address. Ask your Nuance representative to provision the account with the following roles:

• service_user global role
• owner of the company's organization(s)

When the account is enabled, log in to Mix with this account and generate a set of service credentials for this user. Store the client secret in the key vault of the company and share it only when integration scripts need to use this account. This approach ensures the security of the assets accessed by the service account when logged into the platform.

In addition to being the service account user for machine-to-machine communication, this account has the organization owner role, so it can be used to manage user roles and permissions in the organization.

Generate service credentials for Mix.api

You can create a new client ID and credentials to use as a service account.

To generate service credentials for Mix.api:

1. Log in to Mix using the service account.
2. In Mix.dashboard, click the user account name and select Profile.
3. In the Service Credentials area, click Create Service Credentials.

This creates a client ID for the service account.

To generate the client secret for the service account:

1. In the Service Credentials area, click Generate Client Secret.

The client secret is generated. Save this client secret somewhere safe, as you will not be able to access it again from your profile page.

Request an access token

To request an access token from the Nuance authorization server, you need the following information:

Name	Description
grant_type	Always set this to client_credentials.
scope	Scope for the client credentials grant. Enter : mix-api
client_id	Specify the service client ID. For example: mix-api-client:e9a7e628-fa6a-4a40-b4c1-25ac4e7c65fc. See Specifying the client ID in your application for details.
client_secret	Enter the client secret that you generated for the service client ID.
URL of the Nuance authorization server	This is: https://auth.crt.nuance.co.uk/oauth2/token

When requesting an access token, the Nuance authorization server returns:

• The access token
• The token expiration (provided as the number of seconds after which the token will expire)
• The scope
• The token type (always set to bearer)

The following code shows a sample token request using curl:

Notes:

• The curl command uses python to parse the response received from the Nuance authorization server and extract the token only.
• Note that the colons in the Client_ID are escaped (using %3A instead of :) so that the curl command can be split correctly.

$ export CLIENT_ID="mix-api-client%3Ae9a7e628-fa6a-4a40-b4c1-25ac4e7c65fc"
$ export SECRET="riAbk888CC2B.97D7eUklVe6pD"
$ export TOKEN="`curl -s -u "$CLIENT_ID:$SECRET" "https://auth.crt.nuance.co.uk/oauth2/token" -d "grant_type=client_credentials" -d "scope=mix-api" | python -m json.tool |  python -c 'import sys, json; print(json.load(sys.stdin)["access_token"])'`"

Save the token returned in a safe place, as you will need it to access the runtime services.

Specify the access token

You specify the token obtained from the Mix access token service as the credentials when creating a gRPC channel.

When using a REST API, specify the access token as a bearer token in the request header.

Specifying the client ID in your application

The client ID for Mix.api is composed of the string mix-api-client: followed by a unique ID. When specifying the client ID, you may need to escape the colon (i.e., :), depending on how you are passing the client ID in your application.

For example, when using the curl command, which already uses a colon in the user option (-u), you need to replace the colon with %3A. For example:

$ export CLIENT_ID="mix-api-client%3Ae9a7e628-fa6a-4a40-b4c1-25ac4e7c65fc"
$ export SECRET="riAbk888CC2B.97D7eUklVe6pD"
$ export TOKEN="`curl -s -u "$CLIENT_ID:$SECRET" ... 

OAuth 2.0 Authorization Code flow

The OAuth 2.0 Authorization Code grant type flow works as follows:

• Your client application asks you for the permission to use your Mix user credentials. If you approve, the Mix authorization service sends an authorization code to the client app, through a redirect URL. A redirect URL (also sometimes called a callback URL) is an essential part of the OAuth flow. Because the Mix authorization service returns sensitive information (in this case, the authorization code), it is critical that the service does not redirect the user to an arbitrary location. The redirect URL must have been previously registered with the Mix authorization service.
• The client application sends a POST request with the authorization code to the Mix authorization service, which returns an access token.

You then specify this access token in each of the Mix.api calls that your application makes.

The Authorization Code grant type requires that the app launches a browser to begin the flow, as shown in the following diagram:

(Click the image for a close-up view)

1. The client application launches a browser.
2. The browser redirects the user to the Mix authorization service, requesting an authorization code.
3. The Mix authorization service presents the Mix login screen, asking you to provide your Mix user ID and password.
4. You enter your credentials.
5. The Mix authorization service verifies the credentials and displays the consent window, asks whether you allow access to your application.
6. You allow access to your application.
7. The Mix authorization service creates the authorization code.
8. The Mix authorization service redirects to the redirect URL with the authorization code.
9. The client application requests the access token, using the authorization code.
10. The Mix authorization service returns the access token.
11. The client application can now perform Mix.api calls using the access token.

For more information

For more information about OAuth 2.0 and the Authorization Code grant type, see:

• https://www.oauth.com/
• https://developer.okta.com/blog/2018/04/10/oauth-authorization-code-grant-type

Implement the Authorization Code flow in your client application

There are many ways that you can implement the OAuth 2 authorization flow for Mix.api in your client application.

As a summary, your application needs to:

1. Obtain and configure the information required by the authorization flow.
2. Create a web server that will handle the redirect URL.
3. Get the authorization code.
4. Get the access token.

Information required by the Authorization Code flow

Your application must provide the following information at different times during the Authorization Code flow:

Parameter	Description
Client ID	ID that identifies the client. For the Authorization Code flow, this is the Default client ID. See Generate the client secret for the default Mix.api account.
Client secret	Secret password associated with the client ID. You generate this from your User Profile on the Mix.dashboard. See Generate the client secret for the default Mix.api account.
Redirect URL	Redirect URL where authorization responses can be sent and received by your client application. This is the web server that is hosting the OAuth library. It must exactly match one of the redirect URLs that you registered on the Mix.dashboard. See Register the redirect URL.
Authorization server URL	This is the URL of the Mix authorization service: auth.crt.nuance.co.uk.
Tenant	Value added in the path of the request to control who can sign into the application. For Mix.api, this is mix.
Scope	Specifies the permissions that the application is requesting. For Mix.api, this is mix-api.

Generate the client secret for the default Mix.api account

The profile page provides your default Client ID, which is the client ID that you need if you want to implement the Authorization Code grant type flow in your application.

You also generate the client secret for the default Mix.api account from your user profile.

To generate the client secret for the default Mix.api account:

1. In Mix.dashboard, click your name and select Profile.
2. In the Default area, click Generate Client Secret.

The client secret is generated. Save this client secret somewhere safe, as you will not be able to access it again from your profile page.

Register the redirect URL

This step registers the redirect URL with the Mix authorization service. Your client application must provide the same redirect URL when requesting an authorization code from the Mix authorization service.

To register a redirect URL:

1. In the Mix dashboard, click your name and select Profile.
2. In the Redirect URLs field, enter the redirect URL (for example, http://localhost:3000/callback) and click the + icon.
3. Refresh the page to confirm that your redirect URL has been added.

Update an existing redirect URL

To update an existing redirect URL, update the URL in the appropriate field and click Update Redirect URLs.

Regenerate the client secret

You may need to regenerate the client secret for secret rotation or if, for example, you lose it or it has become compromised.

Note that this procedure regenerates the client secret for Mix.api for the default account or the service account only. This client secret is used for the Mix.api authoring environment. It has no impact on the credentials used in your runtime client applications.

To regenerate the client secret:

1. In the Mix dashboard, click your name and select Profile.
2. Click Regenerate Client Secret for either the default account or the service account, as appropriate.
3. To regenerate the client secret, click "I understand. Regenerate Client Secret."

Set up authorization for the Swagger documentation

To use the Mix.api endpoints directly from the Swagger documentation, you must first authorize your account.

The Swagger documentation uses the OAuth 2.0 Client Credentials flow, so you need to create an access token using service credentials and specify it in the Swagger documentation.

You can set up authorization in the Swagger documentation in two says:

• Specify service credentials
• Generate the access token and specify it as a bearer token

Specify service credentials

You can specify your service credentials directly in the Swagger documentation to call the endpoints:

1. In the Swagger documentation, click Authorize.
   The Available authorizations window appears.
2. Enter your service credentials in the OAuth2 (OAuth2, application) section, as follows:
   • In client_id, enter the client ID for your service credentials. See Generate service credentials for Mix.api for details. Make sure to escape the colon in the client ID, as described in Specifying the client ID in your application.
   • In client_secret, enter the client secret for this client ID. See Generate service credentials for Mix.api.
3. Select the mix-api scope.
4. Click Authorize.
5. Click Close.

You can now use the Mix.api endpoints until the token expires.

Authorize with a bearer token

To call the endpoints, you can also generate the access token and then specify it as a bearer token in the Swagger documentation:

1. Generate service credentials for Mix.api.
2. Request an access token.
3. In the Swagger documentation, click Authorize.
   The Available authorizations window appears.
4. In the value field of the bearerAuth (apiKey) section, enter the string Bearer followed by the access token generated in step 2. For example:
   
5. Click Authorize.
6. Click Close.

You can now use the Mix.api endpoints until the token expires.

Errors

Mix.api uses the standard HTTP codes to indicate whether a request was successful or not.

In particular, it uses the following codes:

HTTP code	Message	Indicates
200	OK	Request was successful.
400	BAD_REQUEST	(Used for the Get Bot Config Interface request) The configId specified does not exist in the bot specifed by botId.
401	UNAUTHORIZED	The credentials specified are incorrect or expired. Troubleshooting: Make sure that you have generated the access token and that you are providing the credentials as described in Authorization. Note that the token needs to be regenerated regularly. See Access token lifetime for details.
404	NOT_FOUND	One of the parameter specified could not be found.
500	INTERNAL_SERVER_ERROR	There was an issue on the server side. Troubleshooting: Contact Nuance.

Pagination

Endpoints that can return many results—such as Get geographies, Get jobs, Get projects, and so on—use pagination to help manage the results returned.

These endpoints provide the following query parameters to manage results:

Query parameter	Description	Default value
limit	Page size limit: Maximum number of results returned	10
offset	Offset to use when returning results	0

Mix.api v4 Reference

At the top level, an organization is the parent entity that contains the projects, applications, environments, deployment flows, and so on. An organization has members, and members have roles.

Nuance also defines a set of geographies that are available for all organizations. A geography is the physical region where the Nuance runtime services are deployed.

An organization defines the language topics that are available to create projects. A language topic describes a type of ASR core data packs and customizes the language model within the data pack that is used for recognition.

A deployment flow implements the different steps of a customer's application lifecycle in Mix. Deployment flows are customizable per customer and are specific to an organization. Each step in the deployment flow is deployed to a customer's environment.

Projects are created in an organization. They can include ASR, NLU, and dialog builds. An application with configurations that include dialog builds is a bot.

Version

The Version endpoint provides details about the different Mix versions.

In particular, this endpoint can be used to obtain the Mix.api version, which increases when changes are made to the API. The Mix.api versions and related updates are tracked in the change log.

Get system versions

Example responses

200 Response

{
  "mixEnvironment": "us",
  "mixVersion": "3.5.10",
  "apiVersion": "0.9.4"
}

GET /v4/version

Retrieve the Mix environment, Mix version, and Mix.api version.

Responses

Status	Meaning	Description	Schema
200	OK	List of versions	mix.api.Version
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Geographies

Geographies

* US
* Canada
* Sandbox US

A geography is the physical region where the Nuance runtime services are deployed so that they can be accessed by client applications. The geographies available are defined by Nuance and usually represent countries or top-level regions; for example, "US", "Canada", "EU", and so on.

Nuance also provides the "Sandbox US" geography. Every Mix user has access to a Mix Sample App to deploy and use models in a Sandbox environment. A Mix Sample App exists in the Sandbox US geography.

Get geographies

Example responses

200 Response

{
  "geographies": [
    {
      "id": "1",
      "displayName": "Sandbox US"
    },
    {
      "id": "14",
      "displayName": "US"
    },
    {
      "id": "16",
      "displayName": "Canada"
    }
  ],
  "totalSize": 3,
  "count": 3,
  "limit": 10,
  "offset": 0
}

GET /v4/geographies

Retrieve the list of geographies.

You can limit the number of results returned and use an offset to determine the starting position of results returned.

You can also sort the results by id or displayName and specify the sort order with the - or + sign. For example, to sort by alphabetical order of displayName, enter +displayName. You can also specify multiple sorting fields by separating them with commas; for example: +displayName, -id. By default, results are sorted by alphabetical order of ID.

Parameters

Name	In	Type	Description
limit	query	integer(int32)	Maximum number of query results returned.
offset	query	integer(int32)	Offset to use when returning results.
sortBy	query	array[string]	Sort parameter; use the format: +displayName.

Responses

Status	Meaning	Description	Schema
200	OK	List of geographies.	mix.api.ListGeographiesResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Jobs

Some of the tasks performed by the API, such as building models and importing files, may take some time to execute.

To manage these tasks, Mix provides jobs. A job is created for complex tasks and assigned a unique job ID in a project. For example, when you start a build, the endpoint returns a job ID. You can then use the Get job details endpoint with this job ID to poll the status of the job and get a detailed report.

When you delete a job, it is deleted from the database, but the job keeps running until it completes or fails.

Get job details

Example responses

200 Response

{
  "id": "430a4626-3b41-4fa2-bb8b-db1c7c2c7189",
  "type": "APPEND_INTENT_SAMPLES",
  "projectId": "2960",
  "status": "COMPLETED",
  "report": {
    "addProjectIntentSamplesReports": {
      "reports": [
        {
          "status": "COMPLETED",
          "locale": "en-US",
          "createTime": "2021-06-08T21:10:38.076Z"
        }
      ]
    }
  },
  "createTime": "2021-06-08T21:10:37.456Z",
  "updateTime": "2021-06-08T21:10:52.052Z",
  "duration": "14.596s"
}

GET /v4/projects/{projectId}/jobs/{jobId}

Retrieve the details of a job in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.
jobId	path	string	ID of the job.

Responses

Status	Meaning	Description	Schema
200	OK	Job details	mix.api.JobResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Job not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Delete a job

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

DELETE /v4/projects/{projectId}/jobs/{jobId}

Delete the specified job.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.
jobId	path	string	ID of the job.

Responses

Status	Meaning	Description	Schema
200	OK	Job successfully deleted	google.rpc.Status
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Job not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get jobs

Example responses

200 Response

{
  "jobs": [
    {
      "id": "430a4626-3b41-4fa2-bb8b-db1c7c2c7189",
      "type": "APPEND_INTENT_SAMPLES",
      "projectId": "2960",
      "status": "COMPLETED",
      "createTime": "2021-06-08T21:10:37.456Z",
      "updateTime": "2021-06-08T21:10:52.052Z",
      "duration": "14.596s"
    }
  ],
  "totalSize": 1,
  "count": 1,
  "limit": 10,
  "offset": 0
}

GET /v4/projects/{projectId}/jobs

Retrieve the list of jobs available in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.
limit	query	integer(int32)	Maximum number of job results to return.
offset	query	integer(int32)	Offset to use when returning results.
sortBy	query	array[string]	Sort parameter; use the format: +id.

Responses

Status	Meaning	Description	Schema
200	OK	List of jobs	mix.api.ListProjectJobsResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Organizations

Organizations

Personal organization: "alex.smith@company.com"
Standard organization: "Mix.api Test Organization"

An organization is the parent entity that contains members, projects, applications, environments, deployment flows, and their associated credentials.

Users are members of two or more organizations. There are two types of organizations:

• Personal: This is a user's personal organization and is specified with the user's email address. All users own a personal organization, which includes a sample application (Mix Sample App), a sandbox environment, a deployment flow, as well as trial credentials.
• Standard: A standard organization groups users with a specific email domain. In addition to their personal organization, every user is part of a standard organization that is represented by the business email domain. A standard organization often represents a company, university, and so on. Nuance can also create other standard organizations for a customer. The organization owner can then manage the organization.

Some of the functionality is controlled at the organization level. This includes, for example, access to prebuilt domains, voice packs and language topics available, and more.

Users also have a role inside an organization. By default, the following roles are available:

• Owner — Can invite users, edit organization details, and create projects.
• Member — Can see the organization details and collaborate on projects/applications.
• Viewer — Can see the organization details, projects, and applications, but cannot edit them.
• Expert — Can access advanced platform capabilities, such as importing rule-based grammars.

Note: New roles can be added through a custom Nuance engagement.

The different organization types as well as user roles determine the permissions that are available in terms of projects, applications, tools (such Mix.dialog and Mix.nlu), and so on.

Some examples:

• When a project is created in an organization, it is shared with all the members in this organization.
• If a user is not part of the organization in which a project is created, this user will not see the project. To share a project with a user that is not in your organization, you must add that user as a member of the project.
• A user with a viewer role can see the Mix.nlu and Mix.dialog data for a project, but cannot edit them.

Get organizations

Example responses

200 Response

{
  "organizations": [
    {
      "id": "233",
      "displayName": "Mix.api Test Organization",
      "type": "STANDARD",
      "members": [
        {
          "member": {
            "id": "36",
            "email": "alex.smith@company.com",
            "name": "Alex Smith",
            "createTime": "2020-01-16T15:44:25.231Z",
            "lastLoginTime": "2021-01-26T13:07:16.644Z"
          },
          "roles": [
            {
              "id": "2",
              "displayName": "member",
              "description": "Can see the organization details and collaborate on projects/applications."
            }
          ]
        }
      ],
      "isDeepLearningModelEnabled": true,
      "isEnginePacksEnabled": false,
      "isDataPacksEnabled": false
    },
    {
      "id": "37",
      "displayName": "alex.smith@company.com",
      "type": "PERSONAL",
      "members": [
        {
          "member": {
            "id": "36",
            "email": "alex.smith@company.com",
            "name": "Alex Smith",
            "createTime": "2020-01-16T15:44:25.231Z",
            "lastLoginTime": "2021-01-26T13:07:16.644Z"
          },
          "roles": [
            {
              "id": "1",
              "displayName": "owner",
              "description": "Can invite users, edit organization details, and create projects and applications."
            }
          ]
        }
      ],
      "isDeepLearningModelEnabled": false,
      "isEnginePacksEnabled": true,
      "isDataPacksEnabled": false
    }
  ],
  "totalSize": 1,
  "count": 1,
  "limit": 0,
  "offset": 0
}

GET /v4/organizations

Retrieve the list of organizations that correspond to the query criteria specified.

Parameters

Name	In	Type	Description
type	query	string	Type of organizations to return.
view	query	string	Organization view to return.
showAll	query	boolean	When set to true, shows all existing organizations. This flag requires specific permissions; while it is visible to all users, it will be enabled only for users with these permissions.
limit	query	integer(int32)	Maximum number of query results returned.
offset	query	integer(int32)	Offset to use when returning results.
sortBy	query	array[string]	Sort parameter; use the format: +id.
filter	query	string	Filter results parameter: can be organization ID or organization display name. The search is case sensitive.
includeShared	query	boolean	When set to true, also returns the organizations that contain projects to which the user has access.

Detailed descriptions

type: Type of organizations to return.

• TYPE_UNSPECIFIED: All types of organizations
• PERSONAL: User's personal organization, identified with the user's email address
• STANDARD: Global organization, such as a company, that typically includes many members

view: Organization view to return.

• VIEW_UNSPECIFIED: Returns organization details without listing the organization members
• FULL: Returns all organization details, including the list of organization members

Responses

Status	Meaning	Description	Schema
200	OK	List of organizations	mix.api.ListOrganizationsResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Language Topics

Language topics

* gen
    * en-US
    * fr-CA

A language topic describes a type of ASR core data packs. Each topic provides a specialized, yet still general, knowledge of a domain (such as the banking domain or the retail domain). The topic customizes the language model within the data pack that is used for recognition.

One or more language topics may be available to customers:

• gen: The default gen language topic (which is short for General) includes the default ASR core data packs and is available to all Mix users. This language topic can be used for general chat applications and has no specialization.
• genfast¹: This topic provides customizations that provide better performance in certain IVR settings.
• dtv¹: This language topic provides customizations for applications with TV vocabulary.
• Customer-specific language topics may also be available. They contain customizations that are specific to the customer's applications.

^{1. These language topics are not enabled by default. Please contact your Nuance representative for more information.}

Language topics are specific to an organization.

Get language topics

Example responses

200 Response

{
  "languageTopics": [
    {
      "id": "1",
      "name": "gen",
      "locales": [
        {
          "locale": "fr-CA",
          "language": "fr",
          "country": "CA",
          "displayLanguage": "French",
          "displayCountry": "Canada"
        },
        {
          "locale": "en-US",
          "language": "en",
          "country": "US",
          "displayLanguage": "English",
          "displayCountry": "United States",
          "versions": [
            "4.7.0",
            "4.5.0",
            "4.4.0",
            "4.2.0"
          ]
        }
      ]
    }
  ]
}

GET /v4/organizations/{orgId}/language-topics

Retrieve the list of language topics available in an organization.

Parameters

Name	In	Type	Description
orgId	path	string	ID of the organization for which to get the list of language topics.

Responses

Status	Meaning	Description	Schema
200	OK	List of language topics	mix.api.ListLanguageTopicsResponse
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

Environments

Environments and environment geographies

   Environment: Sandbox
      EnvironmentGeography: Sandbox US (337)
         host=api.nuance.com type=SANDBOX
   Environment: Development
      EnvironmentGeography: US (338)
         host=api.nuance.com type=SANDBOX
   Environment: QA
      EnvironmentGeography: US (339)
         host=api.nuance.com type=SANDBOX
   Environment: Staging
      EnvironmentGeography: US (340)
         host=api.nuance.com type=PRODUCTION
      EnvironmentGeography: Canada (343)
         host=api.nuance.ca type=PRODUCTION 
   Environment: Production
      EnvironmentGeography: US (341)
         host=api.nuance.com type=PRODUCTION
      EnvironmentGeography: Canada (342)
         host=api.nuance.ca type=PRODUCTION 

An environment is a logical entity that allows customers to reproduce their deployment flow lifecycle in Mix. For example, to implement a lifecycle that includes a development step, a QA step, and a production step, Nuance creates three customer-specific environments: Development, QA, and Production. These environments are created at the organization level, so they are available to all members of the organization.

Each environment has one or more environment geography. An environment geography is an instance of the runtime services made available to customers in their respective custom environment for a specific geography. For example, in the lifecycle example above, an environment geography could be Development-US. Not all geographies must be available for all environments; for example, the Development and QA environments may use the "US" geography only, but Production uses both "US" and "Canada":

Environment geographies also include this information:

• The host provides the location of the Mix.api stack
• The environment type (sandbox or production) defines the level of service that can be expected

Environments and environment geographies are specific to an organization.

Get organization environments

Example responses

200 Response

{
  "environments": [
    {
      "id": "300",
      "displayName": "Sandbox",
      "geographies": [
        {
          "id": "337",
          "geography": {
            "id": "1",
            "displayName": "Sandbox US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ]
    },
    {
      "id": "301",
      "displayName": "Development",
      "geographies": [
        {
          "id": "338",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ]
    },
    {
      "id": "302",
      "displayName": "QA",
      "geographies": [
        {
          "id": "339",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ]
    },
    {
      "id": "303",
      "displayName": "Staging",
      "geographies": [
        {
          "id": "340",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        },
        {
          "id": "343",
          "geography": {
            "id": "16",
            "displayName": "Canada"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ]
    },
    {
      "id": "304",
      "displayName": "Production",
      "geographies": [
        {
          "id": "341",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        },
        {
          "id": "342",
          "geography": {
            "id": "16",
            "displayName": "Canada"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ]
    }
  ],
  "totalSize": 5,
  "count": 5,
  "limit": 10,
  "offset": 0
}

GET /v4/organizations/{orgId}/environments

Get the list of environments available in an organization.

You can limit the number of results returned and use an offset to determine the starting position of results returned.

You can also sort the results by id or displayName and specify the sort order with the - or + sign. For example, to sort by alphabetical order of displayName, enter +displayName. You can also specify multiple sorting fields by separating them with commas; for example: +displayName, -id. By default, results are sorted by alphabetical order of environment ID.

Parameters

Name	In	Type	Description
orgId	path	string	ID of the organization for which to get the list of environments.
limit	query	integer(int32)	Maximum number of query results returned.
offset	query	integer(int32)	Offset to use when returning results.
sortBy	query	array[string]	Sort parameter; use the format: +displayName.

Responses

Status	Meaning	Description	Schema
200	OK	List of environments in the organization specified.	mix.api.ListEnvironmentsResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Deployment Flows

Deployment flows

   Flow: Default Deployment Flow (262)
      DeploymentFlowStep: 1 (338) requires_approval=False
        Environment: Sandbox
   Flow: Multi-Stage Pipeline (263)
      DeploymentFlowStep: 1 (339) requires_approval=False
        Environment: Development
      DeploymentFlowStep: 2 (340) requires_approval=False
        Environment: QA
      DeploymentFlowStep: 3 (341) requires_approval=False
        Environment: Staging
      DeploymentFlowStep: 4 (342) requires_approval=True
        Environment: Production

A deployment flow implements the different steps of a customer's application lifecycle in Mix. Deployment flows are customizable per customer and are specific to an organization.

For example, consider the following application deployment lifecycle:

There are three steps in this lifecycle: Development, QA, and Production. When you create a bot configuration, you specify the deployment flow to use. You move your configuration sequentially through the deployment flow; you must go through each step in your flow.

For example, in the lifecycle above, Mix resources are first deployed in a development environment, where they can be worked on and initially tested. They are then deployed to a QA environment for further testing. When QA is completed, they are deployed to a production environment.

When a configuration is deployed to a new environment, all the required configuration data gets published to that environment, where you can access and test it.

Depending on the deployment flow used for the configuration, some steps may require an approval. In this case, the request will be queued for approval by your Nuance representative.

By default, all users have access to the default deployment flow in their personal organization, which consists of a single step, "Sandbox".

Get organization deployment flows

Example responses

200 Response

{
  "flows": [
    {
      "id": "262",
      "displayName": "Default Deployment Flow",
      "steps": [
        {
          "id": "338",
          "step": 1,
          "requiresApproval": false,
          "environments": [
            {
              "id": "300",
              "displayName": "Sandbox",
              "geographies": [
                {
                  "id": "337",
                  "geography": {
                    "id": "9",
                    "displayName": "US"
                  },
                  "envType": "SANDBOX",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "263",
      "displayName": "Multi-Stage Pipeline",
      "steps": [
        {
          "id": "339",
          "step": 1,
          "requiresApproval": false,
          "environments": [
            {
              "id": "301",
              "displayName": "Development",
              "geographies": [
                {
                  "id": "338",
                  "geography": {
                    "id": "14",
                    "displayName": "US"
                  },
                  "envType": "SANDBOX",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        },
        {
          "id": "340",
          "step": 2,
          "requiresApproval": false,
          "environments": [
            {
              "id": "302",
              "displayName": "QA",
              "geographies": [
                {
                  "id": "339",
                  "geography": {
                    "id": "14",
                    "displayName": "US"
                  },
                  "envType": "SANDBOX",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        },
        {
          "id": "341",
          "step": 3,
          "requiresApproval": false,
          "environments": [
            {
              "id": "303",
              "displayName": "Staging",
              "geographies": [
                {
                  "id": "340",
                  "geography": {
                    "id": "14",
                    "displayName": "US"
                  },
                  "envType": "PRODUCTION",
                  "envHost": "api.nuance.co.uk"
                },
                {
                  "id": "343",
                  "geography": {
                    "id": "16",
                    "displayName": "Canada"
                  },
                  "envType": "PRODUCTION",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        },
        {
          "id": "342",
          "step": 4,
          "requiresApproval": true,
          "environments": [
            {
              "id": "304",
              "displayName": "Production",
              "geographies": [
                {
                  "id": "341",
                  "geography": {
                    "id": "14",
                    "displayName": "US"
                  },
                  "envType": "PRODUCTION",
                  "envHost": "api.nuance.co.uk"
                },
                {
                  "id": "342",
                  "geography": {
                    "id": "16",
                    "displayName": "Canada"
                  },
                  "envType": "PRODUCTION",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totalSize": 2,
  "count": 2,
  "limit": 10,
  "offset": 0
}

GET /v4/organizations/{orgId}/deployment-flows

Get the list of deployment flows available in an organization.

You can limit the number of results returned and use an offset to determine the starting position of results returned.

You can also sort the results by id or displayName and specify the sort order with the - or + sign. For example, to sort by alphabetical order of displayName, enter +displayName. You can also specify multiple sorting fields by separating them with commas; for example: +displayName, -id.

Parameters

Name	In	Type	Description
orgId	path	string	ID of the organization for which to get the list of deployment flows.
limit	query	integer(int32)	Maximum number of query results returned.
offset	query	integer(int32)	Offset to use when returning results.
sortBy	query	array[string]	Sort parameter; use the format: +displayName.

Responses

Status	Meaning	Description	Schema
200	OK	List of deployment flows in the organization specified.	mix.api.ListDeploymentFlowsResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Bots

Bots

* Mix.api Test Bot

Bot configurations (uses Multi-Stage deployment flow)

* TestBotV3 deployments:
  - Development (id=339): Deployed
  - QA (id=340): Deployed
  - Staging (id=341): Pending request
  - Production (id=342): Undeployed

Bot credentials (for Mix.api Test Bot)

* Development
  - appId: mixapi-testbot-dev
* QA
  - appId: mixapi-testbot-qa
* Staging
  - appId: mixapi-testbot-stage
* Production
  - appId: mixapi-testbot-prod

Bot interface

* Channels: Audio VA, Text VA, Digital VA, IVR/Voice VA, Omni Channel VA
* Variables: accountList, language, intentValue, date, returnMessage, timezone, myAccount, userData, lastConfirmationResultObject, channelIntegration, randomInt, etc.
* TransferNodes: MainEnd, EscalateAction (variables: myAccount, user, intentLiteral)

A bot is a Mix application with configurations that include dialog builds. Integrators use the DLGaaS API to interact as needed with bot applications.

Bots can take speech, text, or a natural language interpretation as input, perform reasoning in context using NLU, and can produce synthesized speech, orchestrating the entire experience with an end user.

For example, through the DLGaaS API, integrators can have bots that:

• Stream audio to ASRaaS
• Use their own third-party NLU interpretation engine or Mix NLUaaS to perform interpretation
• Produce synthesized speech through TTSaaS

Bots have bot configurations. A bot configuration is a Mix application configuration with a dialog build. It describes the deployment flow that the bot configuration has gone through. A bot configuration is identified with a context tag, which points to specific versions of Mix resources. Configurations are deployed to environment geographies using a deployment flow.

You can access the deployed configurations using a set of bot credentials for the respective environment. Credentials include OAuth clients that are used to access runtime services. Clients also have OAuth scopes that determine the services that they can access.

Bot configuration interfaces are obtained from a bot configuration and provide an integration layer that describes the languages, channels and modalities, variables, as well as transfer nodes (both end and escalate) of a bot.

The Mix.api Bots endpoints provide integrators with the metadata necessary to call the DLGaaS API. For example:

• The Get Bot Credentials endpoint provides the information required to authorize the client application
• The Get Bot Config endpoint provides the context tag to specify the bot URN in the StartRequest payload
• The Get Bot Config Interface endpoint provides the variables that can be passed at SessionStart
• The Get Bot Config Interface endpoint also provides the variables that are expected by the transfer nodes; this allows integrators to determine the data that must be passed back from the ExecuteResponse

Get list of bots

Example responses

200 Response

{
  "bots": [
    {
      "id": "233",
      "applicationName": "Mix.api Test Bot",
      "configs": [
        {
          "id": "1386",
          "tag": "TestBotV3",
          "deployments": [
            {
              "id": "342",
              "status": "PENDING_REQUEST",
              "envGeographyDeployments": []
            },
            {
              "id": "341",
              "status": "UNDEPLOYED",
              "envGeographyDeployments": []
            },
            {
              "id": "340",
              "status": "DEPLOYED",
              "envGeographyDeployments": [
                {
                  "id": "1160",
                  "envGeography": {
                    "id": "339",
                    "geography": {
                      "id": "14",
                      "displayName": "US"
                    },
                    "envType": "SANDBOX",
                    "envHost": "api.nuance.co.uk",
                    "envName": "QA"
                  },
                  "status": "DEPLOYED",
                  "deploymentResult": "success",
                  "isOverridden": false,
                  "dataHosts": []
                }
              ]
            },
            {
              "id": "339",
              "status": "PENDING_REQUEST",
              "envGeographyDeployments": []
            }
          ],
          "parentId": "",
          "hasInterface": true,
          "deploymentFlowId": 263,
          "createTime": "2021-01-28T01:19:59Z"
        }
      ],
      "createTime": "2021-01-18T16:39:02Z"
    }
  ],
  "totalSize": 1
}

GET /v4/organizations/{orgId}/bots

Retrieve the list of bots available in the organization specified.

Parameters

Name	In	Type	Description
orgId	path	string	ID of the organization for which to get the list of bots.
view	query	string	Bots view to return.

Detailed descriptions

view: Bots view to return.

• BV_VIEW_UNSPECIFIED: Returns bot details without including application configurations
• BV_FULL: Returns all bot details, including the list of application configurations
• BV_FULL_AVAILABLE_CONFIGS: Returns all bot details, omitting configs that are overridden
• BV_FULL_LIVE_CONFIGS: Returns all bot configs that are deployed

Responses

Status	Meaning	Description	Schema
200	OK	List of bots	mix.api.ListBotsResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get bot credentials

Example responses

200 Response

{
  "credentials": [
    {
      "id": "522",
      "credential": {
        "id": "272",
        "appId": "mixapi-testbot-dev",
        "clients": [
          {
            "id": "531",
            "clientId": "appID:mixapi-testbot-dev:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:13.178Z",
            "updateTime": "2021-01-18T16:39:13.178Z"
          },
          {
            "id": "535",
            "clientId": "appID:mixapi-testbot-dev:geo:dev:clientName:logging",
            "clientName": "logging",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:03:32.775Z",
            "updateTime": "2021-01-18T17:03:32.775Z"
          }
        ],
        "createTime": "2021-01-18T16:39:13.175Z",
        "updateTime": "2021-01-18T16:39:13.175Z"
      },
      "geographies": [
        {
          "id": "338",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:39:49.151Z",
      "updateTime": "2021-01-18T16:39:49.151Z"
    },
    {
      "id": "523",
      "credential": {
        "id": "273",
        "appId": "mixapi-testbot-qa",
        "clients": [
          {
            "id": "532",
            "clientId": "appID:mixapi-testbot-qa:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:17.915Z",
            "updateTime": "2021-01-18T16:39:17.915Z"
          },
          {
            "id": "538",
            "clientId": "appID:mixapi-testbot-qa:geo:dev:clientName:logging",
            "clientName": "logging",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:04:21.761Z",
            "updateTime": "2021-01-18T17:04:21.761Z"
          }
        ],
        "createTime": "2021-01-18T16:39:17.911Z",
        "updateTime": "2021-01-18T16:39:17.911Z"
      },
      "geographies": [
        {
          "id": "339",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:39:57.024Z",
      "updateTime": "2021-01-18T16:39:57.024Z"
    },
    {
      "id": "524",
      "credential": {
        "id": "274",
        "appId": "mixapi-testbot-stage",
        "clients": [
          {
            "id": "533",
            "clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:21.056Z",
            "updateTime": "2021-01-18T16:39:21.056Z"
          },
          {
            "id": "537",
            "clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:logging",
            "clientName": "logging",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:04:16.400Z",
            "updateTime": "2021-01-18T17:04:16.400Z"
          }
        ],
        "createTime": "2021-01-18T16:39:21.053Z",
        "updateTime": "2021-01-18T16:39:21.053Z"
      },
      "geographies": [
        {
          "id": "340",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:40:02.936Z",
      "updateTime": "2021-01-18T16:40:02.936Z"
    },
    {
      "id": "525",
      "credential": {
        "id": "274",
        "appId": "mixapi-testbot-stage",
        "clients": [
          {
            "id": "533",
            "clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:21.056Z",
            "updateTime": "2021-01-18T16:39:21.056Z"
          },
          {
            "id": "537",
            "clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:logging",
            "clientName": "logging",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:04:16.400Z",
            "updateTime": "2021-01-18T17:04:16.400Z"
          }
        ],
        "createTime": "2021-01-18T16:39:21.053Z",
        "updateTime": "2021-01-18T16:39:21.053Z"
      },
      "geographies": [
        {
          "id": "343",
          "geography": {
            "id": "16",
            "displayName": "Canada"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:40:07.748Z",
      "updateTime": "2021-01-18T16:40:07.748Z"
    },
    {
      "id": "526",
      "credential": {
        "id": "275",
        "appId": "mixapi-testbot-prod",
        "clients": [
          {
            "id": "534",
            "clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:25.297Z",
            "updateTime": "2021-01-18T16:39:25.297Z"
          },
          {
            "id": "536",
            "clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:neap",
            "clientName": "neap",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:03:39.865Z",
            "updateTime": "2021-01-18T17:03:39.865Z"
          }
        ],
        "createTime": "2021-01-18T16:39:25.294Z",
        "updateTime": "2021-01-18T16:39:25.294Z"
      },
      "geographies": [
        {
          "id": "341",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:40:15.046Z",
      "updateTime": "2021-01-18T16:40:15.046Z"
    },
    {
      "id": "527",
      "credential": {
        "id": "275",
        "appId": "mixapi-testbot-prod",
        "clients": [
          {
            "id": "534",
            "clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:25.297Z",
            "updateTime": "2021-01-18T16:39:25.297Z"
          },
          {
            "id": "536",
            "clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:neap",
            "clientName": "neap",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:03:39.865Z",
            "updateTime": "2021-01-18T17:03:39.865Z"
          }
        ],
        "createTime": "2021-01-18T16:39:25.294Z",
        "updateTime": "2021-01-18T16:39:25.294Z"
      },
      "geographies": [
        {
          "id": "342",
          "geography": {
            "id": "16",
            "displayName": "Canada"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:40:36.728Z",
      "updateTime": "2021-01-18T16:40:36.728Z"
    }
  ]
}

GET /v4/bots/{botId}/credentials

Retrieve the list of bot credentials that correspond to the query criteria specified.

Parameters

Name	In	Type	Description
botId	path	string	ID of the bot for which to get the list of credentials.
envGeographyName	query	string	Name of the environment geography; for example, US.
view	query	string	Bot credentials view to return.

Detailed descriptions

view: Bot credentials view to return.

• BCV_VIEW_UNSPECIFIED: Returns credentials details without including clients
• BCV_FULL: Returns all credentials details, including list of clients

Responses

Status	Meaning	Description	Schema
200	OK	List of bot credentials	mix.api.ListBotCredentialsResponse
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

Get list of bot configurations

Example responses

200 Response

{
  "configs": [
    {
      "id": "1386",
      "tag": "TestBotV3",
      "deployments": [
        {
          "id": "339",
          "status": "DEPLOYED",
          "envGeographyDeployments": [
            {
              "id": "1159",
              "envGeography": {
                "id": "338",
                "geography": {
                  "id": "1",
                  "displayName": "Sandbox US"
                },
                "envType": "SANDBOX",
                "envHost": "api.nuance.co.uk"
              },
              "status": "DEPLOYED",
              "deploymentResult": "success",
              "isOverridden": false
            }
          ]
        },
        {
          "id": "340",
          "status": "DEPLOYED",
          "envGeographyDeployments": [
            {
              "id": "1160",
              "envGeography": {
                "id": "339",
                "geography": {
                  "id": "1",
                  "displayName": "Sandbox US"
                },
                "envType": "SANDBOX",
                "envHost": "api.nuance.co.uk"
              },
              "status": "DEPLOYED",
              "deploymentResult": "success",
              "isOverridden": false
            }
          ]
        },
        {
          "id": "341",
          "status": "PENDING_REQUEST",
          "envGeographyDeployments": []
        },
        {
          "id": "342",
          "status": "UNDEPLOYED",
          "envGeographyDeployments": []
        }
      ],
      "parentId": "null",
      "hasInterface": true,
      "createTime": "2021-01-28T01:19:59.415Z"
    }
  ]
}

GET /v4/bots/{botId}/configs

Retrieve the list of application configurations available for a bot.

Parameters

Name	In	Type	Description
botId	path	string	ID of the bot for which to get the list of application configurations.
tag	query	string	Context tag name to filter the results.
appId	query	string	Runtime app ID to filter the results; for example, NMDPTRIAL_alex_smith_company_com_20190919T190532.
excludeOverrides	query	boolean	When set to true, bot configurations that are overridden are excluded from the list.
liveOnly	query	boolean	When set to true, returns only bot configurations that are currently deployed.

Responses

Status	Meaning	Description	Schema
200	OK	List of application configurations for the bot	mix.api.ListBotConfigsResponse
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

Get bot config interface

Example responses

200 Response

{
  "interface": {
    "id": "1159",
    "version": 7,
    "languageTopic": "gen",
    "locales": [
      "en-US"
    ],
    "channels": [
      {
        "id": "8e432bd2-6512-4da3-8236-66a6f94b6e44",
        "displayName": "Audio VA",
        "codeName": "Audio VA",
        "modes": [
          "TTS"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "88544ae0-9fe1-4a3b-b7eb-129614c3532a",
        "displayName": "Text VA",
        "codeName": "Text VA",
        "modes": [
          "RICH_TEXT"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "bd47faf3-ec97-4f63-ac8d-53f7822c2d24",
        "displayName": "IVR/Voice VA",
        "codeName": "IVR/Voice VA",
        "modes": [
          "AUDIO_SCRIPT"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "42dcfbf7-86b2-46f8-b495-0d3bf7907248",
        "displayName": "Digital VA",
        "codeName": "Digital VA",
        "modes": [
          "INTERACTIVITY",
          "RICH_TEXT",
          "TTS"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "454bea86-0e77-49b4-b527-0188d46a52c2",
        "displayName": "Omni Channel VA",
        "codeName": "Omni Channel VA",
        "modes": [
          "AUDIO_SCRIPT",
          "INTERACTIVITY",
          "RICH_TEXT",
          "TTS"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "23371c6d-2760-4aed-af6e-13c75d86f3a6",
        "displayName": "Default",
        "codeName": "default",
        "modes": [
          "TTS",
          "AUDIO_SCRIPT",
          "RICH_TEXT",
          "INTERACTIVITY"
        ],
        "color": "COLOR_UNSPECIFIED"
      }
    ],
    "variables": [
      {
        "id": "f1718da9-1653-4f5e-a0c1-3d1f581231d6",
        "displayName": "accountList",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "LIST_TYPE",
        "complexGenericTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
      },
      {
        "id": "a49808bf-4f4f-4e38-bb35-7e173547cb06",
        "displayName": "language",
        "description": "The current language; initially set to the default language of the project",
        "isReserved": true,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "d2dc5ba3-98da-4292-8fe7-a619682d725a",
        "displayName": "intentValue",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "5cf039f0-c109-4243-971a-3f46f501f999",
        "displayName": "date",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "DATE_TYPE"
      },
      {
        "id": "34e222aa-5489-4870-934a-a7d7460110ca",
        "displayName": "returnMessage",
        "description": "The return message variable that describes the meaning of the returnCode variable",
        "isReserved": true,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "dcb0e74f-1bd2-4f1f-a342-e3ccee4e5fad",
        "displayName": "timezone",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "f864ab5e-e951-402e-a9fb-c9f905e1d13a",
        "displayName": "myAccount",
        "description": "",
        "isReserved": false,
        "complexVariableTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
      },
      {
        "id": "3cc3578f-7f41-4761-a15e-19e621d6b681",
        "displayName": "userData",
        "description": "The data collected from the end user.",
        "isReserved": true,
        "complexVariableTypeId": "c4ea5e93-fca4-40a8-99c9-bb442f6ec0cc"
      },
      {
        "id": "e4f2b89b-9551-4ebb-8d6d-2e513d814d35",
        "displayName": "lastConfirmationResultObject",
        "description": "",
        "isReserved": true,
        "complexVariableTypeId": "21f00d74-95f7-4cbf-a20e-ea877ea72de1"
      },
      {
        "id": "9cf698cd-445e-4dac-9fa7-620db10b654b",
        "displayName": "channelIntegration",
        "description": "The channel integration on the client-side.",
        "isReserved": true,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "11ad45b4-f7ac-4b2e-832e-f32f6ad51da3",
        "displayName": "randomInt",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "INTEGER_TYPE"
      },
      {
        "id": "9422d27d-5b61-4e05-8701-c4cbf8352219",
        "displayName": "payeeWordset",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "DYNAMIC_ENTITY_DATA"
      },
      {
        "id": "2d0e7d7f-04b1-4403-9f07-9944df0a929f",
        "displayName": "accountTypeWordset",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "DYNAMIC_ENTITY_DATA"
      },
      {
        "id": "fb8a0614-1f3f-428c-97f5-e3d241723f5d",
        "displayName": "nulString",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "47bce83f-9d4a-4a79-a6b4-c36d605b59a4",
        "displayName": "myMessageVar",
        "description": "",
        "isReserved": false,
        "complexVariableTypeId": "a5133103-dfe2-4432-83ba-0a057ecbc05d"
      },
      {
        "id": "d7ce400f-dc6f-4e7d-80e5-f0744b8a776e",
        "displayName": "temp",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "AMOUNT_TYPE"
      },
      {
        "id": "51b23544-6986-418b-beda-14486fd37656",
        "displayName": "intentLiteral",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "b2112948-d648-4f90-a3ef-02457b1776c4",
        "displayName": "returnCode",
        "description": "The return code variable for data access nodes",
        "isReserved": true,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "b519fa46-c4bc-431d-b4c6-e846445c4af6",
        "displayName": "confidenceScore",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "86b14181-5dcf-449a-b1b9-03f43a22bd80",
        "displayName": "lastCollectionResultObject",
        "description": "",
        "isReserved": true,
        "complexVariableTypeId": "21f00d74-95f7-4cbf-a20e-ea877ea72de1"
      },
      {
        "id": "7f24bf8d-519f-4f47-9a31-e594b6d5d0be",
        "displayName": "user",
        "description": "",
        "isReserved": false,
        "complexVariableTypeId": "d6c03136-1c81-47ec-a0c4-e1d04415e3aa"
      },
      {
        "id": "afaa4ea6-ecd8-42a6-bc30-cc5ded710cc0",
        "displayName": "previousIntent",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      }
    ],
    "transferNodes": [
      {
        "id": "5414ad73-0da7-47ae-9f4a-d870cc8f4e27",
        "nodeName": "MainEnd",
        "nodeType": "END",
        "description": "",
        "requestVariables": []
      },
      {
        "id": "86880327-8fa6-4aba-b3d3-f9317215956f",
        "nodeName": "EscalateAction",
        "nodeType": "ESCALATE",
        "description": "",
        "requestVariables": [
          {
            "id": "f864ab5e-e951-402e-a9fb-c9f905e1d13a",
            "displayName": "myAccount",
            "description": "",
            "isReserved": false,
            "complexVariableTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
          },
          {
            "id": "7f24bf8d-519f-4f47-9a31-e594b6d5d0be",
            "displayName": "user",
            "description": "",
            "isReserved": false,
            "complexVariableTypeId": "d6c03136-1c81-47ec-a0c4-e1d04415e3aa"
          },
          {
            "id": "51b23544-6986-418b-beda-14486fd37656",
            "displayName": "intentLiteral",
            "description": "",
            "isReserved": false,
            "simpleVariableType": "STRING_TYPE"
          }
        ]
      }
    ],
    "createTime": "2021-01-28T01:19:03.468Z"
  }
}

GET /v4/bots/{botId}/configs/{configId}/interface

Retrieves the configuration interface (locales, channels, variables, and so on) for a bot.

Parameters

Name	In	Type	Description
botId	path	string	ID of the bot for which to get the configuration interface.
configId	path	string	ID of the application configuration for which to get the interface.

Responses

Status	Meaning	Description	Schema
200	OK	Configuration interface for a bot	mix.api.GetBotConfigInterfaceResponse
400	Bad Request	Request contains invalid arguments	Inline
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

Projects

When you create a project, you specify:

• The language topic
• The list of languages that will be supported
• The list of channels and modalities that will be available for the project

A project is created in an organization and is shared with all the members in this organization. If a user is not part of the organization in which a project is created, this user will not see the project. To share a project with a user that is not in your organization, you must add that user as a member of the project.

Users also have a role inside a project. Members can have one of the following default project roles:

• Owner: Can perform all actions on the project.
• Admin: Can perform all actions on the project except:
  • Delete the project
  • Edit project details
• Viewer: Can see the organization details, projects, and applications, but cannot edit them.

About exported project packages

The package files exported with the project and metadata export endpoints use the following naming convention:

projectid-projectname-[metadata]-exportdate-exporttime[.zip|.json]

where:

• projectid is the ID of the project
• projectname is the name of the project
• metadata indicates that the metadata file was exported
• exportdate is the date that the package was exported, in the yyyy-mm-dd format
• exporttime is the time that the package was exported, in the hh-mm-ss format, using Greenwich Mean Time (GMT)

The project package is exported to a .zip file; the metadata package is exported to a .json file.

For example:

• Package export: 2960-Coffee App-2021-05-27-20-39-10.zip
• Metadata export: 2960-Coffee App-metadata-2021-06-02-17-26-49.json

Project package file structure

A project package can include the following files:

File name	Description	Availability	Package export	Metadata export
dialog.json	File that defines the dialog application. See the Dialog Application Specification for details.	All users	X
metadata.json	File that defines the metadata of the project, such as the date and time the project was created, name of the project, channels and modalities of the project, and so on.	All users	X	X
locale/locale.trsx (for example, en_US/en_US.trsx)	TRSX file that defines the NLU ontology for a locale. The content provided depends on the type of package exported (complete project or ontology only). See the TRSX documentation for details.	All users	X
locale/grammars/*	GrXML files that define any rule-based grammars. See Rule-based grammars for details. Only available if rule-based grammars have been defined for this project.	Nuance Professional Services users (see note)	X
locale/_client_prons.txt	ASR pronunciation file. Only available if pronunciations have been uploaded for this project.	Nuance Professional Services users (see note)	X
locale/_tmfe.tsv	ASR transformations file. Only available if a Transformation Modeling Front End (TMFE) file has been uploaded for this project.	Nuance Professional Services users (see note)	X

Replacing a project package

When you replace a project package, the contents of the files included in the project package replace the content of the project.

Make sure to include all the files described in Project package file structure, following the same structure, otherwise your project may not be replaced correctly.

Get list of Mix projects

Example responses

200 Response

{
  "projects": [
    {
      "id": "23079",
      "displayName": "GA Bank Demo",
      "languageTopic": "gen",
      "channels": [
        {
          "channel": {
            "id": "454bea86-0e77-49b4-b527-0188d46a52c2",
            "displayName": "Omni Channel VA",
            "codeName": "custom",
            "modes": [
              "INTERACTIVITY",
              "AUDIO_SCRIPT",
              "TTS",
              "RICH_TEXT"
            ],
            "color": "PURPLE"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "42dcfbf7-86b2-46f8-b495-0d3bf7907248",
            "displayName": "Digital VA",
            "codeName": "custom",
            "modes": [
              "RICH_TEXT",
              "TTS",
              "INTERACTIVITY"
            ],
            "color": "GREEN"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "bd47faf3-ec97-4f63-ac8d-53f7822c2d24",
            "displayName": "IVR Voice VA",
            "codeName": "custom",
            "modes": [
              "AUDIO_SCRIPT"
            ],
            "color": "LIGHT_ORANGE"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "23371c6d-2760-4aed-af6e-13c75d86f3a6",
            "displayName": "Default",
            "codeName": "default",
            "modes": [
              "INTERACTIVITY",
              "RICH_TEXT",
              "TTS",
              "AUDIO_SCRIPT"
            ],
            "color": "COLOR_UNSPECIFIED"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "88544ae0-9fe1-4a3b-b7eb-129614c3532a",
            "displayName": "Text VA",
            "codeName": "custom",
            "modes": [
              "RICH_TEXT"
            ],
            "color": "CORN_FLOWER"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "8e432bd2-6512-4da3-8236-66a6f94b6e44",
            "displayName": "Audio VA",
            "codeName": "custom",
            "modes": [
              "TTS"
            ],
            "color": "PINK"
          },
          "isActive": true
        }
      ],
      "datapacks": [
        {
          "displayName": "fr-FR",
          "version": "4.1.0",
          "isActive": true,
          "isDefault": false
        },
        {
          "displayName": "en-US",
          "version": "4.7.0",
          "isActive": true,
          "isDefault": true
        }
      ],
      "isFavorite": false,
      "orgId": "233",
      "orgDisplayName": "Mix.api Test Organization",
      "policy": {
        "isAccepted": true,
        "projectDescription": "",
        "createTime": "2021-08-12T11:58:10Z",
        "updateTime": "2021-08-12T11:58:10Z"
      },
      "createTime": "2021-01-18T16:44:58Z",
      "updateTime": "2021-01-28T19:23:27Z",
      "baseDatapack": "9.4.4",
      "enginePackFeatures": [
        "xmix-3458_spacing-flag",
        "xmix-3774_qa-sensitive"
      ],
      "lastSavedTime": "2021-08-16T13:04:12Z",
      "lastUsedTime": "2021-08-16T11:59:08Z",
      "lastAsrModelCreateTime": "2021-01-28T01:19:00Z",
      "lastNluModelCreateTime": "2021-01-28T01:18:58Z",
      "lastDialogModelCreateTime": "2021-01-28T01:19:03Z"
    }
  ],
  "count": 1,
  "totalSize": 1,
  "limit": 10,
  "offset": 0
}

GET /v4/projects

Retrieve the list of Mix projects to which you have access, across all organizations. This endpoint returns an extended set of attributes for each project.

You can limit the number of results returned and use an offset to determine the starting position of results returned.

Parameters

Name	In	Type	Description
orgId	query	string	ID of the organization for which to get the list of projects.
limit	query	integer(int32)	Maximum number of query results returned.
offset	query	integer(int32)	Offset to use when returning results.
sortBy	query	array[string]	Sort parameter; use the format: +id.
filter	query	string	Filter results parameter: can be project ID or project display name. The search is case sensitive.
excludeChannels	query	boolean	When set to true, the project channels are excluded from the list. This will boost API performance.
includeFeatures	query	boolean	When set to true, includes the list of features supported by this project's engine pack.

Responses

Status	Meaning	Description	Schema
200	OK	List of projects	mix.api.ListExtendedProjectsResponse
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

Update Nuance data pack version

Body parameter

{
  "locale": "string",
  "version": "string"
}

Example responses

200 Response

{
  "id": "430a4626-3b41-4fa2-bb8b-db1c7c2c7189",
  "type": "APPEND_INTENT_SAMPLES",
  "projectId": "2960",
  "status": "COMPLETED",
  "report": {
    "addProjectIntentSamplesReports": {
      "reports": [
        {
          "status": "COMPLETED",
          "locale": "en-US",
          "createTime": "2021-06-08T21:10:38.076Z"
        }
      ]
    }
  },
  "createTime": "2021-06-08T21:10:37.456Z",
  "updateTime": "2021-06-08T21:10:52.052Z",
  "duration": "14.596s"
}

PUT /v4/projects/{projectId}/.datapack

Update the Nuance data pack version used by a project for a locale.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project for which to update the Nuance data pack.
body	body	mix.api.DataPackUpdateRequest	Locale to update and new version to update it to.

Responses

Status	Meaning	Description	Schema
200	OK	Job to update data pack successfully created	mix.api.JobResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project or data pack not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get organization projects

Example responses

200 Response

{
  "projects": [
    {
      "id": "23079",
      "displayName": "GA Bank Demo",
      "languageTopic": "gen",
      "channels": [
        {
          "channel": {
            "id": "33428",
            "displayName": "Audio VA",
            "codeName": "Audio VA",
            "modes": [
              "TTS"
            ],
            "color": "PINK"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "33427",
            "displayName": "Text VA",
            "codeName": "Text VA",
            "modes": [
              "RICH_TEXT"
            ],
            "color": "CORN_FLOWER"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "33426",
            "displayName": "Digital VA",
            "codeName": "Digital VA",
            "modes": [
              "INTERACTIVITY",
              "RICH_TEXT",
              "TTS"
            ],
            "color": "GREEN"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "33425",
            "displayName": "IVR/Voice VA",
            "codeName": "IVR/Voice VA",
            "modes": [
              "AUDIO_SCRIPT",
              "DTMF"
            ],
            "color": "LIGHT_ORANGE"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "33424",
            "displayName": "Omni Channel VA",
            "codeName": "Omni Channel VA",
            "modes": [
              "AUDIO_SCRIPT",
              "DTMF",
              "INTERACTIVITY",
              "RICH_TEXT",
              "TTS"
            ],
            "color": "PURPLE"
          },
          "isActive": true
        }
      ],
      "datapacks": [
        {
          "displayName": "fr-FR",
          "version": "4.1.0",
          "isActive": true
        },
        {
          "displayName": "en-US",
          "version": "4.7.0",
          "isActive": true
        }
      ],
      "orgId": "2",
      "createTime": "2021-01-18T16:44:58.947Z",
      "updateTime": "2021-01-18T16:45:56Z"
    }
  ]
}

GET /v4/organizations/{orgId}/projects

Retrieve the list of projects available in an organization.

Parameters

Name	In	Type	Description
orgId	path	string	ID of the organization for which to get the list of projects.
excludeChannels	query	boolean	When set to true, the project channels are excluded from the list. This will boost API performance.

Responses

Status	Meaning	Description	Schema
200	OK	List of projects	mix.api.ListProjectsResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Organization not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Create a new project

Body parameter

{
  "displayName": "string",
  "languages": [
    "string"
  ],
  "languageTopic": "string",
  "channels": [
    {
      "displayName": "string",
      "modes": [
        "MODE_UNSPECIFIED"
      ],
      "color": "COLOR_UNSPECIFIED"
    }
  ],
  "projectDescription": "string",
  "isChildDataCompliant": "NO",
  "enginePackId": "string"
}

Example responses

200 Response

{
  "project": {
    "id": "23977",
    "displayName": "Quick Start",
    "languageTopic": "gen",
    "channels": [
      {
        "channel": {
          "id": "34791",
          "displayName": "Text VA",
          "modes": [
            "RICH_TEXT"
          ],
          "color": "GREEN"
        },
        "isActive": true
      }
    ],
    "datapacks": [
      {
        "isActive": true,
        "displayName": "en-US",
        "version": "4.7.0",
        "isDefault": true
      },
      {
        "isActive": true,
        "displayName": "fr-CA",
        "version": "4.1.0",
        "isDefault": true
      }
    ],
    "baseDatapack": "9.4.1.19",
    "orgId": "2",
    "createTime": "2021-03-02T20:18:09.281Z",
    "updateTime": "2021-03-02T20:18:03Z"
  }
}

POST /v4/organizations/{orgId}/projects

Create a new project in an organization.

Nuance’s Child Data Policy is related to online services that are subject to applicable child data privacy laws, such as, but not limited to, the Children’s Online Privacy Protection Act (COPPA) and Article 8 of GDPR. Nuance’s Child Data Policy prohibits providing hosted services to websites or online services that are primarily directed towards children under the age of 16.

When you create a project, you are required to acknowledge whether or not the builds for this project will be used in an application that is deployed in a Nuance hosted service in connection with an online site, service, application or product that is primarily directed to children under 16. This acknowledgement must be completed for any projects that are intended for use in the Nuance SaaS cloud.

To acknowledge such a project, set the isChildDataCompliant parameter to YES and provide a description of the project in projectDescription.

Parameters

Name	In	Type	Description
orgId	path	string	ID of the organization under which the project will be created.
body	body	mix.api.ProjectRequest	Object that defines the project to create.

Responses

Status	Meaning	Description	Schema
200	OK	Project successfully created	mix.api.CreateProjectResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Organization not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get project details

Example responses

200 Response

{
  "project": {
    "id": "23079",
    "displayName": "GA Bank Demo",
    "languageTopic": "gen",
    "channels": [
      {
        "channel": {
          "id": "33424",
          "displayName": "Omni Channel VA",
          "codeName": "Omni Channel VA",
          "modes": [
            "AUDIO_SCRIPT",
            "DTMF",
            "INTERACTIVITY",
            "RICH_TEXT",
            "TTS"
          ],
          "color": "PURPLE"
        },
        "isActive": true
      },
      {
        "channel": {
          "id": "33425",
          "displayName": "IVR/Voice VA",
          "codeName": "IVR/Voice VA",
          "modes": [
            "AUDIO_SCRIPT",
            "DTMF"
          ],
          "color": "LIGHT_ORANGE"
        },
        "isActive": true
      },
      {
        "channel": {
          "id": "33426",
          "displayName": "Digital VA",
          "codeName": "Digital VA",
          "modes": [
            "INTERACTIVITY",
            "RICH_TEXT",
            "TTS"
          ],
          "color": "GREEN"
        },
        "isActive": true
      },
      {
        "channel": {
          "id": "33427",
          "displayName": "Text VA",
          "codeName": "Text VA",
          "modes": [
            "RICH_TEXT"
          ],
          "color": "CORN_FLOWER"
        },
        "isActive": true
      },
      {
        "channel": {
          "id": "33428",
          "displayName": "Audio VA",
          "codeName": "Audio VA",
          "modes": [
            "TTS"
          ],
          "color": "PINK"
        },
        "isActive": true
      }
    ],
    "datapacks": [
      {
        "displayName": "fr-FR",
        "version": "4.1.0",
        "isActive": true,
        "isDefault": true
      },
      {
        "displayName": "en-US",
        "version": "4.7.0",
        "isActive": true,
        "isDefault": true
      }
    ],
    "baseDatapack": "9.4.1.25",
    "orgId": "2",
    "createTime": "2021-01-18T16:44:58.947Z",
    "updateTime": "2021-01-18T16:45:56Z"
  }
}

GET /v4/projects/{projectId}

Retrieve the details of a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project for which to get details.

Responses

Status	Meaning	Description	Schema
200	OK	Project details	mix.api.GetProjectResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Delete a project

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

DELETE /v4/projects/{projectId}

Delete a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project to delete.

Responses

Status	Meaning	Description	Schema
200	OK	Project successfully deleted	google.rpc.Status
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Rename a project

Body parameter

{
  "displayName": "string"
}

Example responses

200 Response

{
  "displayName": "string"
}

PUT /v4/projects/{projectId}/.rename

Rename a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project to rename.
body	body	mix.api.RenameProjectPayload	Object that defines the new project name.

Responses

Status	Meaning	Description	Schema
200	OK	Project successfully renamed	mix.api.RenameProjectPayload
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Export the project package

GET /v4/projects/{projectId}/.export

Export the project package to a .zip file. Note that the grammar, transformation, and pronunciation files are restricted and not available to all users. As such, the project package exported by regular users will not include these files. Regular users may end up with an incomplete project after calling this endpoint. See About exported project packages for details.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project to export.

Responses

Status	Meaning	Description	Schema
200	OK	Project package (zip file, with application/octet-stream content-type)	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Replace project content

Example responses

Job successfully created

{
  "id": "28ac16d0-0115-4391-928f-bfef40ea3ba9",
  "type": "REPLACE_PROJECT",
  "projectId": "26089",
  "status": "RUNNING",
  "createTime": "2022-01-17T16:22:46Z",
  "updateTime": "2022-01-17T16:22:46Z"
}

POST /v4/projects/{projectId}/.replace

Replace the project content with the .zip file provided in the content parameter. !!! IMPORTANT !!! This endpoint may permanently delete data. When replacing an existing project, Nuance recommends that you back up the existing project by first exporting it. Note that the grammar, transformation, and pronunciation files are restricted and not available to all users. As such, regular users are not allowed to replace grammar, transformation, and pronunciation files, so they may end up with an incomplete project after calling this endpoint. See Replacing a project package for details.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project to replace.
» content	body	string(binary)	Zip file of the project content to replace.

Responses

Status	Meaning	Description	Schema
200	OK	Job successfully created	mix.api.JobResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Export the project metadata

GET /v4/projects/{projectId}/metadata/.export

Export the project metadata to a .json file.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to export metadata.

Responses

Status	Meaning	Description	Schema
200	OK	Project metadata (json file, with application/json content-type)	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get project lock

Example responses

200 Response

{
  "lock": {
    "lockId": "18",
    "projectId": "2960",
    "lockOwner": {
      "id": "36",
      "email": "alex.smith@company.com"
    },
    "notes": "Exporting model",
    "createTime": "2021-11-10T15:33:35Z"
  }
}

GET /v4/projects/{projectId}/.lock

Retrieve the details of a specific project lock.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.

Responses

Status	Meaning	Description	Schema
200	OK	Project lock details	mix.api.GetProjectLockResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Unlock a project

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

PUT /v4/projects/{projectId}/.unlock

Unlock a project. Other users with appropriate permissions will now be able to edit the project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project to unlock.

Responses

Status	Meaning	Description	Schema
200	OK	Project successfully unlocked	google.rpc.Status
401	Unauthorized	Request could not be authorized	Inline
403	Forbidden	Request not allowed	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Lock a project

Body parameter

{
  "notes": "string"
}

Example responses

200 Response

{
  "lock": {
    "lockId": "18",
    "projectId": "2960",
    "lockOwner": {
      "id": "36",
      "email": "alex.smith@company.com"
    },
    "notes": "Exporting model",
    "createTime": "2021-11-10T15:33:35Z"
  }
}

PUT /v4/projects/{projectId}/.lock

Lock a project. When you lock a project, other users will be able to view the project in Mix.nlu, Mix.dialog, and Mix.dashboard but will not be able to edit the project. Also, other Mix.api users will not be able to call endpoints that edit the project; these endpoints will return an error message indicating that the project is locked.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project to lock.
body	body	mix.api.LockRequest	Object that defines the project lock notes.

Responses

Status	Meaning	Description	Schema
200	OK	Project successfully locked	mix.api.LockProjectResponse
400	Bad Request	Bad request	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get project locks

Example responses

200 Response

{
  "locks": [
    {
      "lockId": "2",
      "projectId": "21647",
      "lockOwner": {
        "id": "1",
        "email": "admin@company.com"
      },
      "notes": "Building models",
      "createTime": "2021-11-04T14:55:36Z"
    },
    {
      "lockId": "18",
      "projectId": "2960",
      "lockOwner": {
        "id": "36",
        "email": "alex.smith@company.com"
      },
      "notes": "Exporting model",
      "createTime": "2021-11-10T15:33:35Z"
    }
  ],
  "totalSize": 2,
  "count": 2,
  "limit": 10,
  "offset": 0
}

GET /v4/projects/.locks

Retrieve the list of projects locks in all organizations.

You can limit the number of results returned and use an offset to determine the starting position of results returned.

By default, results are sorted by alphabetical order of lock ID. You can also sort the results by another field and specify the sort order with the - or + sign. For example, to sort by alphabetical order of projectId, enter +projectId.

Note that this endpoint is restricted to Nuance Professional Services and global admin users.

Parameters

Name	In	Type	Description
projectId	query	string	ID of the project to filter the results.
userId	query	string	ID of the user to filter the results.
orgId	query	string	ID of the organization for which to get the project locks.
limit	query	integer(int32)	Maximum number of query results returned.
offset	query	integer(int32)	Offset to use when returning results.
sort	query	array[string]	Deprecated. sort fields.
sortBy	query	array[string]	Sort parameter; use the format: +projectId.

Responses

Status	Meaning	Description	Schema
200	OK	List of projects locks	mix.api.ListProjectsLocksResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Create project channel

Body parameter

{
  "displayName": "string",
  "modes": [
    "MODE_UNSPECIFIED"
  ],
  "color": "COLOR_UNSPECIFIED"
}

Example responses

200 Response

{
  "channel": {
    "id": "33849b2a-24f5-493e-b156-d91799d5186d",
    "displayName": "Custom channel",
    "codeName": "custom",
    "modes": [
      "RICH_TEXT"
    ],
    "color": "INDIGO"
  },
  "isActive": true
}

POST /v4/projects/{projectId}/channels

Create a new channel in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project where to create the channel.
body	body	mix.api.ChannelRequest	Object that defines the project channel to create.

Responses

Status	Meaning	Description	Schema
200	OK	Project channel details	mix.api.CreateProjectChannelResponse
400	Bad Request	Project not found	Inline
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Update project channel

Body parameter

{
  "channelId": "string",
  "modes": [
    "MODE_UNSPECIFIED"
  ],
  "color": "COLOR_UNSPECIFIED"
}

Example responses

200 Response

{
  "channel": {
    "id": "33849b2a-24f5-493e-b156-d91799d5186d",
    "displayName": "Custom channel",
    "codeName": "custom",
    "modes": [
      "INTERACTIVITY"
    ],
    "color": "SALMON"
  },
  "isActive": true
}

PUT /v4/projects/{projectId}/.channel

Update the channel details in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project for which to update the channel.
body	body	mix.api.UpdateChannelRequest	Object that defines the project channel to update.

Responses

Status	Meaning	Description	Schema
200	OK	Updated project channel details	mix.api.UpdateProjectChannelResponse
400	Bad Request	Project not found	Inline
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Activate project channel

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

PUT /v4/projects/{projectId}/channels/{channelId}/.activate

Activate a channel in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.
channelId	path	string	ID of the channel.
body	body	object	Leave this body empty.

Responses

Status	Meaning	Description	Schema
200	OK	Project channel successfully activated	google.rpc.Status
400	Bad Request	Project not found	Inline
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Deactivate project channel

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

PUT /v4/projects/{projectId}/channels/{channelId}/.deactivate

Deactivate a channel in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.
channelId	path	string	ID of the channel.
body	body	object	Leave this body empty.

Responses

Status	Meaning	Description	Schema
200	OK	Project channel successfully deactivated	google.rpc.Status
400	Bad Request	Project not found	Inline
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Rename project channel

Body parameter

{
  "displayName": "Updated channel name"
}

Example responses

200 Response

{
  "displayName": "Updated channel name"
}

PUT /v4/projects/{projectId}/channels/{channelId}/.rename

Rename a channel in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to rename the channel.
channelId	path	string	ID of the channel to rename.
body	body	mix.api.RenameProjectChannelPayload	New channel name.

Responses

Status	Meaning	Description	Schema
200	OK	Project channel successfully renamed	mix.api.RenameProjectChannelPayload
400	Bad Request	Project not found	Inline
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Engine Packs

An engine pack is a set of pre-determined ASR, NLU, TTS, and Dialog engine versions that are compatible.

When you create a project, you select the engine pack version that corresponds to the engines that you have installed in your self-hosted environment. For more information, see Engine packs.

Get engine packs

Example responses

200 Response

{
  "enginePacks": [
    {
      "enginePackId": "d5262497-afa2-4cdf-9d3d-1a3fd70bc0c6",
      "version": "hosted",
      "dialogVersion": "1.0.0",
      "nluVersion": "1.1.0",
      "asrVersion": "1.2.4",
      "ttsVersion": "1.2.0",
      "isDefault": false,
      "topics": {
        "gen": {
          "locales": {
            "fr-CA": {
              "versions": [
                {
                  "version": "4.1.0",
                  "isSupported": true
                },
                {
                  "version": "4.0.0",
                  "isSupported": true
                }
              ]
            },
            "id-ID": {
              "versions": [
                {
                  "version": "4.0.0",
                  "isSupported": true
                }
              ]
            },
            "pt-BR": {
              "versions": [
                {
                  "version": "4.2.0",
                  "isSupported": true
                }
              ]
            },
            "th-TH": {
              "versions": [
                {
                  "version": "4.0.0",
                  "isSupported": true
                }
              ]
            },
            "fr-FR": {
              "versions": [
                {
                  "version": "4.1.0",
                  "isSupported": true
                }
              ]
            },
            "en-US": {
              "versions": [
                {
                  "version": "4.7.0",
                  "isSupported": true
                },
                {
                  "version": "4.5.0",
                  "isSupported": true
                },
                {
                  "version": "4.4.0",
                  "isSupported": true
                },
                {
                  "version": "4.2.0",
                  "isSupported": true
                }
              ]
            }
          }
        }
      }
    }
  ]
}

GET /v4/organizations/{orgId}/engine-packs

Retrieve the list of all available engine packs in an organization as well as the Nuance core data packs that are supported for each engine pack.

Parameters

Name	In	Type	Description
orgId	path	string	ID of the organization for which to get the list of engine packs.

Responses

Status	Meaning	Description	Schema
200	OK	List of engine packs including the locales and data packs supported	mix.api.ListEnginePacksResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Ontology

In Mix, the ontology for your model comprises intents, entities (previously referred to as concepts), information about relationships (for example, between intents and entities or between entities and other entities), and grammars associated with such information.

For more information about ontologies in Mix, see Ontology.

About the exported ontology package

The package file exported with the ontology export endpoint uses the following naming convention:

projectid-projectname-ontology-exportdate-exporttime.zip

where:

• projectid is the ID of the project
• projectname is the name of the project
• exportdate is the date that the package was exported, in the yyyy-mm-dd format
• exporttime is the time that the package was exported, in the hh-mm-ss format, using Greenwich Mean Time (GMT)

For example:

• Ontology export: 2960-Coffee App-ontology-2021-05-31-15-27-33.zip

Ontology package file structure

An ontology package can include the following files:

File name	Description	Availability
locale/locale.trsx (for example, en_US/en_US.trsx)	TRSX file that defines the NLU ontology for a locale. See the TRSX documentation for details.	All users
locale/grammars/name/name.grxml (for example, en_US/grammars/CARD_TYPE/CARD_TYPE.grxml)	GrXML files that define any rule-based grammars. See Rule-based grammars for details. Only available if rule-based grammars have been defined for this project.	Professional Services users (see note)

Appending to an ontology

When you append content to the ontology of the project, the content is added to the existing ontology.

Make sure to include the ontology files (that is, the .TRSX file as well as any corresponding .grxml files) as described in Ontology package file structure, following the same structure.

Export project ontology package

GET /v4/projects/{projectId}/ontology/.export

Export the project ontology package to a .zip file. Note that rule-based grammars are restricted and not available to all users. As such, the ontology package exported by regular users will not include these files. Regular users may end up with an incomplete ontology after calling this endpoint. See About exported ontology packages for details.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to export the ontology.
locales	query	array[string]	List of locales for which to export the ontology.

Responses

Status	Meaning	Description	Schema
200	OK	Ontology package (zip file, with application/octet-stream content-type)	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Append project ontology

Example responses

Job successfully created

{
  "id": "e60b10c6-a766-48a0-b285-5788b8c45f7d",
  "type": "APPEND_ONTOLOGY",
  "projectId": "26089",
  "status": "RUNNING",
  "createTime": "2022-01-17T16:28:17Z",
  "updateTime": "2022-01-17T16:28:17Z"
}

PUT /v4/projects/{projectId}/ontology/.append

Append the content in the provided .zip file to the project ontology.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project to append the ontology to.
» content	body	string(binary)	Zip file of the ontology content to append.

Responses

Status	Meaning	Description	Schema
200	OK	Job successfully created	mix.api.JobResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get entity types

Example responses

200 Response

{
  "entityTypes": [
    {
      "name": "BASE",
      "description": "Predefined Nuance Entity",
      "initializer": {},
      "comaptibleDataTypes": [
        "NO_FORMAT"
      ]
    }
  ]
}

GET /v4/ontology/entity-types

Retrieve the available entity types.

Parameters

Name	In	Type	Description
includeCompatibleDataTypes	query	boolean	When set to true, includes the compatible data types.

Responses

Status	Meaning	Description	Schema
200	OK	List of available entity types	mix.api.ListEntityTypesResponse
400	Bad Request	Bad Request	Inline
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
501	Not Implemented	Feature is not yet enabled	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Samples

Samples consist of phrases or sentences that are used to train an NLU model. Samples are labeled with intents and annotated with entities.

About exported samples

The package file exported with the export samples endpoint uses the following naming convention:

projectid-projectname-intentname-samples-exportdate-exporttime.zip

where:

• projectid is the ID of the project
• projectname is the name of the project
• intentname is the name of the intent for which samples were exported
• exportdate is the date that the package was exported, in the yyyy-mm-dd format
• exporttime is the time that the package was exported, in the hh-mm-ss format, using Greenwich Mean Time (GMT)

For example:

• Samples export: 2960-Coffee App-ORDER_COFFEE-samples-2021-06-01-19-55-35.zip

Samples package file content

A samples package includes one or more TRSX samples file, one for each locale in the project:

File name	Description
locale.trsx (for example, en_US.trsx)	TRSX file that defines the samples for the locale. See the TRSX documentation for details.

Replacing and appending samples

When you replace samples, the samples included in the samples file provided replace the existing samples in the project.

When you append samples, the samples are added to the existing ones.

The samples file provided must be either:

• A valid TRSX file; see the TRSX documentation for details
• A .txt file; see Importing samples for details

Export project intent samples

GET /v4/projects/{projectId}/intents/{intentName}/samples/.export

Export the samples for an intent in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to export the intent samples.
intentName	path	string	Case-sensitive name of intent for which to export the samples.
locales	query	array[string]	List of locales for which to export the samples.

Responses

Status	Meaning	Description	Schema
200	OK	Intent samples package (zip file, with application/octet-stream content-type)	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Append project samples

Example responses

Job successfully created

{
  "id": "133480af-a904-46da-b7a6-237efa698b39",
  "type": "APPEND_INTENT_SAMPLES",
  "projectId": "26089",
  "status": "RUNNING",
  "createTime": "2022-01-17T15:57:40Z",
  "updateTime": "2022-01-17T15:57:40Z"
}

PUT /v4/projects/{projectId}/intents/{intentName}/samples/.append

Append the samples in the provided file to the existing samples for the specified project and intent. The samples must be provided in a valid TRSX file (.trsx) or in a text file (.txt).

Parameters

Name	In	Type	Description
projectId	path	string	ID of project to append the samples to.
intentName	path	string	Case-sensitive name of intent for which to append the samples.
locale	query	string	Locale for which the samples will be appended.
» content	body	string(binary)	Samples content file. Can be .trsx or .txt.

Responses

Status	Meaning	Description	Schema
200	OK	Job successfully created	mix.api.JobResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Replace project intent samples

Example responses

Job successfully created

{
  "id": "7f03a5b1-2add-4c69-8dbd-5cfeebc7d828",
  "type": "REPLACE_INTENT_SAMPLES",
  "projectId": "26089",
  "status": "RUNNING",
  "createTime": "2022-01-17T16:01:00Z",
  "updateTime": "2022-01-17T16:01:00Z"
}

POST /v4/projects/{projectId}/intents/{intentName}/samples/.replace

Replace the existing project samples associated with an intent with the ones provided in the file. The samples must be provided in a valid TRSX file (.trsx) or in a text file (.txt). !!! IMPORTANT !!! This endpoint will delete any existing project samples.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to replace intent samples.
intentName	path	string	Case-sensitive name of intent for which to replace samples.
locale	query	string	Locale for which to replace samples.
» content	body	string(binary)	Samples content file. Can be .trsx or .txt.

Responses

Status	Meaning	Description	Schema
200	OK	Job successfully created	mix.api.JobResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Intents

Intents identify an intended action. The intents endpoints allow you to create, delete, and rename an intent. You can also use them to get details about intents in a project.

See Intents for more information about intents.

Get intents

Example responses

200 Response

{
  "intents": [
    {
      "id": "416ceedc-a18d-4bb0-a0aa-d1abcdd69283",
      "name": "NO_INTENT",
      "isInBaseOntology": true,
      "links": []
    },
    {
      "id": "a9e7428a-5c12-4ead-9aad-c6b7d8723ee7",
      "name": "ORDER_COFFEE",
      "isInBaseOntology": false,
      "links": [
        {
          "entityRef": "COFFEE_SIZE"
        },
        {
          "entityRef": "COFFEE_TYPE"
        }
      ]
    },
    {
      "id": "1f9004f5-e0d1-4c23-98c0-49229a2c07da",
      "name": "nuance_weather_query",
      "isInBaseOntology": false,
      "links": [
        {
          "entityRef": "nuance_common_datetime"
        },
        {
          "entityRef": "nuance_common_location"
        },
        {
          "entityRef": "nuance_common_relative_location"
        },
        {
          "entityRef": "nuance_weather_condition"
        }
      ],
      "dataSource": "nuance_weather"
    }
  ]
}

GET /v4/projects/{projectId}/intents

Retrieve the list of intents available in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to list the intents.

Responses

Status	Meaning	Description	Schema
200	OK	List of intents	mix.api.ListIntentsResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Create a new intent

Body parameter

{
  "intentName": "string"
}

Example responses

200 Response

{
  "intent": {
    "id": "be567689-7948-45db-ae9a-8c18f5dc4634",
    "name": "PAY_COFFEE",
    "isInBaseOntology": false,
    "links": []
  }
}

POST /v4/projects/{projectId}/intents

Create a new intent in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project under which the intent will be created.
body	body	mix.api.CreateIntentPayload	Object that defines the intent to create.

Responses

Status	Meaning	Description	Schema
200	OK	Intent successfully created	mix.api.CreateIntentResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get intent details

Example responses

200 Response

{
  "intent": {
    "id": "a9e7428a-5c12-4ead-9aad-c6b7d8723ee7",
    "name": "ORDER_COFFEE",
    "isInBaseOntology": false,
    "links": [
      {
        "entityRef": "COFFEE_SIZE"
      },
      {
        "entityRef": "COFFEE_TYPE"
      }
    ]
  }
}

GET /v4/projects/{projectId}/intents/{intentName}

Retrieve the details of an intent in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project.
intentName	path	string	Name of the intent.

Responses

Status	Meaning	Description	Schema
200	OK	Intent details	mix.api.GetIntentResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Intent not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Delete an intent

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

DELETE /v4/projects/{projectId}/intents/{intentName}

Delete an intent from a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to delete the intent.
intentName	path	string	Name of the intent to delete.

Responses

Status	Meaning	Description	Schema
200	OK	Intent successfully deleted	google.rpc.Status
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Intent not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Rename an intent

Body parameter

{
  "newIntentName": "string"
}

Example responses

200 Response

{
  "intent": {
    "id": "be567689-7948-45db-ae9a-8c18f5dc4634",
    "name": "PAY_COFFEE",
    "isInBaseOntology": false,
    "links": []
  }
}

PUT /v4/projects/{projectId}/intents/{intentName}/.rename

Rename an intent.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to rename the intent.
intentName	path	string	Name of the intent to update.
body	body	mix.api.RenameIntentPayload	Object that defines the new intent name.

Responses

Status	Meaning	Description	Schema
200	OK	Intent successfully renamed	mix.api.RenameIntentResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Intent not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Entities

An entity is a language construct for a property, or particular detail, related to the user's intent. For example, if the user's intent is to order an espresso drink, entities might include COFFEE_TYPE, FLAVOR, TEMPERATURE, and so on.

See Entities for more information about entity, literals, and values.

About exported entity literals

The package file exported with the export entity literals endpoint uses the following naming convention:

projectid-projectname-entityname-entity-literals-exportdate-exporttime.zip

where:

• projectid is the ID of the project
• projectname is the name of the project
• entityname is the name of the entity for which literal-value pairs were exported
• exportdate is the date that the package was exported, in the yyyy-mm-dd format
• exporttime is the time that the package was exported, in the hh-mm-ss format, using Greenwich Mean Time (GMT)

For example:

• Samples export: 2960-Coffee App-COFFEE_TYPE-entity-literals-2021-06-02-20-36-54.zip

Entity literals package file content

An entity literals package includes one or more TRSX file, one for each locale in the project:

File name	Description
locale.trsx(for example, en_US.trsx)	TRSX file that defines the entity literal-value pairs for the locale. See the TRSX documentation for details.

Replacing and appending entity literals

When you replace entity literals, the information included in the package replaces the existing literals in the project.

When you append entity literals, the entity literals are added to the existing ones.

The file provided must be one of the following:

• A valid TRSX file; see the TRSX documentation for details
• A .list or .nmlist file; see Importing entity literals for details

About exported rule-based grammars

The package file exported with the export rule-based grammar endpoint uses the following naming convention:

projectid_grammarname_grammars.zip

where:

• projectid is the ID of the project
• grammarname is the name of the rule-based grammar

For example:

• Samples export: 2960_CARD_TYPE_grammars.zip

Rule-based grammars package file structure

An ontology package can include the following files:

File name	Description	Availability
locale/name.grxml (for example, en_US/CARD_TYPE.grxml)	GrXML files that define any rule-based grammars. See Rule-based grammars for details. Only available if rule-based grammars have been defined for this project.	Expert and Professional Services users (see note)

Replacing rule-based grammars

When you replace a rule-based grammar, the grammars included in the zip file replace the existing rule-based grammars.

The GrXML files must be provided in a .zip file, in a folder identifying the locale for the grammar (for example, en-US/grammar.grxml).

Get entities

Example responses

200 Response

{
  "entities": [
    {
      "baseEntity": {
        "id": "1d6ea576-1305-47b4-bfba-667ae1935b31",
        "name": "AND",
        "dataType": "NOT_SET"
      }
    },
    {
      "baseEntity": {
        "id": "316009ea-f5a9-40d9-ab77-e2fc268a6f41",
        "name": "NOT",
        "dataType": "NOT_SET"
      }
    },
    {
      "baseEntity": {
        "id": "ddd3faad-a26b-4a0a-839f-88b71c9fbc32",
        "name": "OR",
        "dataType": "NO_FORMAT"
      }
    },
    {
      "baseEntity": {
        "id": "9bb99448-0400-4f3b-9edf-73ed13698ea4",
        "name": "nuance_AMOUNT",
        "dataType": "NOT_SET"
      }
    },
    {
      "listEntity": {
        "id": "bc6c1470-a2a5-4d01-976a-b682a5af6f66",
        "name": "COFFEE_SIZE",
        "isDynamic": false,
        "numLiterals": 5,
        "settings": {
          "isSensitive": false,
          "canonicalize": true
        },
        "dataType": "NO_FORMAT"
      }
    },
    {
      "listEntity": {
        "id": "73cb7c26-fed5-4331-8701-6736d98c40d6",
        "name": "COFFEE_TYPE",
        "isDynamic": false,
        "numLiterals": 9,
        "settings": {
          "isSensitive": false,
          "canonicalize": true
        },
        "dataType": "NO_FORMAT"
      }
    }
  ]
}

GET /v4/projects/{projectId}/entities

Retrieve the list of entities available in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to list the entities.
type	query	string	Entity type to filter the results.

Detailed descriptions

type: Entity type to filter the results.

• UNSPECIFIED: No type specified
• BASE: Base entity
• RELATIONAL: Relationship entity
• LIST: List entity
• FREEFORM: Freeform entity
• REGEX: Regex-based entity
• RULE_BASED: Rule-based entity

Responses

Status	Meaning	Description	Schema
200	OK	List of entities	mix.api.ListEntitiesResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Create a new entity

Body parameter

{
  "listEntity": {
    "name": "BILL_PAID",
    "isDynamic": false,
    "settings": {
      "isSensitive": false,
      "canonicalize": true
    },
    "dataType": "YES_NO",
    "data": {
      "en-US": {
        "entries": [
          {
            "meaning": "yes",
            "patterns": [
              "yes"
            ]
          },
          {
            "meaning": "no",
            "patterns": [
              "no"
            ]
          }
        ]
      }
    }
  }
}

Example responses

200 Response

{
  "entity": {
    "listEntity": {
      "id": "deaacb09-80ad-4bb1-bf2d-352ec62e1e7c",
      "name": "COFFEE_TOPPINGS",
      "isDynamic": false,
      "numLiterals": 0,
      "settings": {
        "isSensitive": false,
        "canonicalize": true
      }
    }
  }
}

POST /v4/projects/{projectId}/entities

Create a new entity in a project. If creating a rule-based entity, a dummy GrXML rule will be used for all languages. This rule can be updated using the Replace rule-based grammar endpoint.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project under which the entity will be created.
body	body	mix.api.CreateEntityPayload	Object that defines the entity to create.

Responses

Status	Meaning	Description	Schema
200	OK	Entity successfully created	mix.api.CreateEntityResponse
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get entity details

Example responses

200 Response

{
  "entity": {
    "listEntity": {
      "id": "73cb7c26-fed5-4331-8701-6736d98c40d6",
      "name": "COFFEE_TYPE",
      "isDynamic": false,
      "numLiterals": 9,
      "settings": {
        "isSensitive": false,
        "canonicalize": true
      },
      "dataType": "NO_FORMAT"
    }
  }
}

GET /v4/projects/{projectId}/entities/{entityName}

Retrieve the details of an entity in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project.
entityName	path	string	Name of the entity.

Responses

Status	Meaning	Description	Schema
200	OK	Entity details	mix.api.GetEntityResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Entity not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Delete an entity

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

DELETE /v4/projects/{projectId}/entities/{entityName}

Delete an entity from a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to delete the entity.
entityName	path	string	Name of the entity to delete.

Responses

Status	Meaning	Description	Schema
200	OK	Entity successfully deleted	google.rpc.Status
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Entity not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Update an entity

Body parameter

{
  "listEntity": {
    "settings": {
      "isSensitive": true
    }
  }
}

Example responses

200 Response

{
  "entity": {
    "listEntity": {
      "id": "335134db-e2f1-48b5-8abe-6dd4c0c4f98c",
      "name": "COFFEE_TOPPINGS",
      "isDynamic": false,
      "numLiterals": 0,
      "settings": {
        "isSensitive": true,
        "canonicalize": true
      },
      "dataType": "NO_FORMAT"
    }
  }
}

PUT /v4/projects/{projectId}/entities/{entityName}

Update an entity's properties in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to update an entity.
entityName	path	string	Name of the entity to update.
body	body	mix.api.EntityPayload	Object that defines the content to update.

Responses

Status	Meaning	Description	Schema
200	OK	Entity successfully updated	mix.api.UpdateEntityResponse
400	Bad Request	The request was invalid; for example, when attempting to change an entity's type	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Entity not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Rename an entity

Body parameter

{
  "newEntityName": "string"
}

Example responses

200 Response

{
  "entity": {
    "listEntity": {
      "id": "335134db-e2f1-48b5-8abe-6dd4c0c4f98c",
      "name": "COFFEE_FLAVORS",
      "isDynamic": false,
      "numLiterals": 0,
      "settings": {
        "isSensitive": true,
        "canonicalize": true
      },
      "dataType": "NOT_SET"
    }
  }
}

PUT /v4/projects/{projectId}/entities/{entityName}/.rename

Rename an entity in a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to rename the entity.
entityName	path	string	Name of the entity to update.
body	body	mix.api.RenameEntityRequest.EntityName	Object that defines the new entity name.

Responses

Status	Meaning	Description	Schema
200	OK	Entity successfully renamed	mix.api.RenameEntityResponse
400	Bad Request	The request was invalid	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Entity not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Change entity type

Body parameter

{
  "newType": "UNSPECIFIED",
  "pattern": "string",
  "isA": "string",
  "hasA": {
    "entities": [
      "string"
    ]
  },
  "data": {
    "property1": {
      "entries": [
        {
          "meaning": "string",
          "patterns": [
            "string"
          ]
        }
      ]
    },
    "property2": {
      "entries": [
        {
          "meaning": "string",
          "patterns": [
            "string"
          ]
        }
      ]
    }
  },
  "dataType": "NOT_SET"
}

Example responses

200 Response

{
  "entity": {
    "freeformEntity": {
      "id": "335134db-e2f1-48b5-8abe-6dd4c0c4f98c",
      "name": "COFFEE_FLAVORS",
      "settings": {
        "isSensitive": true,
        "canonicalize": true
      }
    }
  }
}

PUT /v4/projects/{projectId}/entities/{entityName}/.type

Update the type of an entity to another type. If updating to a regex type, a valid regular expression pattern must be provided and will be applied to all languages initially. If updating to a rule-based grammar, a dummy GrXML rule will be used for all languages initially. This rule can be updated using the Replace rule-based grammar endpoint.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to change the entity type.
entityName	path	string	Name of the entity to update.
body	body	mix.api.ChangeEntityTypeRequest.ChangeEntityTypeData	Object that defines the new entity type.

Responses

Status	Meaning	Description	Schema
200	OK	Entity type successfully changed	mix.api.ChangeEntityTypeResponse
400	Bad Request	The request was invalid; for example, an invalid regular expression for a Regex entity was provided	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Entity not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Export rule-based grammar

GET /v4/projects/{projectId}/entities/{entityName}/grammars/.export

Export the rule-based GrXML grammars for an entity. Note that rule-based grammars are restricted and not available to all users. See About exported rule-based grammars for details.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to export the grammar.
entityName	path	string	Name of entity for which to export the grammar.

Responses

Status	Meaning	Description	Schema
200	OK	A .zip file of the grammar(s)	Inline
400	Bad Request	The request was invalid	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Entity not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Replace rule-based grammar

Example responses

200 Response

{
  "entity": {
    "ruleBasedEntity": {
      "id": "ca863394-2cfb-422d-b593-b90dfdb653b8",
      "name": "DP_NUMBER",
      "localeBasedGrammars": {
        "en-US": "grammar.grxml"
      },
      "settings": {
        "isSensitive": false,
        "canonicalize": true
      }
    }
  }
}

POST /v4/projects/{projectId}/entities/{entityName}/grammars/.replace

Replace the rule-based GrXML grammars for an entity. The GrXML files must be provided in a .zip file, in a folder identifying the locale for the grammar (for example, en-US/grammar.grxml). Note that rule-based grammars are restricted and not available to all users. See Replacing rule-based grammars for details.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to replace the grammar.
entityName	path	string	Name of entity for which to replace the grammar.
» content	body	string(binary)	File that contains the new GrXML content.

Responses

Status	Meaning	Description	Schema
200	OK	Entity GrXML rules updated successfully	mix.api.ReplaceRuleBasedGrammarsResponse
400	Bad Request	The request was invalid	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Entity not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Export the entity literals package

GET /v4/projects/{projectId}/entities/{entityName}/literals/.export

Export the literal-value pairs for an entity.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to export literal-value pairs.
entityName	path	string	Case-sensitive name of the entity for which to export literal-value pairs.
locales	query	array[string]	List of locales for which to export literal-value pairs.

Responses

Status	Meaning	Description	Schema
200	OK	Literal-value pairs (zip file, with application/octet-stream content-type)	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Append the entity literals

Example responses

Job successfully created

{
  "id": "81be5082-f407-42b9-9b28-9a9eb6e9aff9",
  "type": "APPEND_ENTITY_LITERALS",
  "projectId": "26089",
  "status": "RUNNING",
  "createTime": "2022-01-17T16:11:05Z",
  "updateTime": "2022-01-17T16:11:05Z"
}

PUT /v4/projects/{projectId}/entities/{entityName}/literals/.append

Append the literal-value pairs in the provided file to the existing ones for the specified project and entity. The literal-value pairs must be provided in a valid TRSX file (.trsx), a .list file, or a .nmlist file.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project to append literal-value pairs to.
entityName	path	string	Case-sensitive name of the entity to append the literal-value pairs to.
locale	query	string	Locale for which the literal-value pairs will be appended.
» content	body	string(binary)	Entity literals content file. Can be .trsx, .nmlist or .list.

Responses

Status	Meaning	Description	Schema
200	OK	Job successfully created	mix.api.JobResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Replace entity literals

Example responses

Job successfully created

{
  "id": "e1ad1b98-37fc-4996-a24b-b71a2f55fcbd",
  "type": "REPLACE_ENTITY_LITERALS",
  "projectId": "26089",
  "status": "RUNNING",
  "createTime": "2022-01-17T16:19:11Z",
  "updateTime": "2022-01-17T16:19:11Z"
}

POST /v4/projects/{projectId}/entities/{entityName}/literals/.replace

Replace the existing literal-value pairs associated with an entity with the ones provided in the file. The literal-value pairs must be provided in a valid TRSX file (.trsx), a .list file, or a .nmlist file. !!! IMPORTANT !!! This endpoint will delete any existing literal-value pairs.

Parameters

Name	In	Type	Description
projectId	path	string	ID of project for which to replace literal-value pairs.
entityName	path	string	Case-sensitive name of the entity for which to replace literal-value pairs.
locale	query	string	Locale for which to replace literal-value pairs.
» content	body	string(binary)	Entity literals content file. Can be .trsx, .nmlist or .list.

Responses

Status	Meaning	Description	Schema
200	OK	Job successfully created	mix.api.JobResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Data Types

An entity is like a variable containing a piece of information relevant to an intent. Like a variable in a computer program, an entity in Mix can be specified with a data type aligned with the kind of contents the entity will hold. Entities in Mix are shared between Mix.nlu and Mix.dialog. The data type forms a contract between Mix.nlu and Mix.dialog that allows dialog designers to use methods and formatting appropriate to the data type of the entity in messages and conditions.

The Mix.api data type endpoint returns the list of available data types. For more information, see:

• Entity data types in the Mix.dialog documentation
• Data types in the Mix.nlu documentation

Get data types

Example responses

200 Response

{
  "dataTypes": [
    {
      "name": "BOOLEAN",
      "schema": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "BOOLEAN",
        "type": "boolean",
        "description": "Programmatic True or False",
        "properties": {}
      },
      "compatibleEntityTypes": [
        {
          "type": "LIST",
          "default": false,
          "initializer": {
            "literals": [
              {
                "meaning": "true",
                "patterns": [
                  "true"
                ]
              },
              {
                "meaning": "false",
                "patterns": [
                  "false"
                ]
              }
            ]
          }
        },
        {
          "type": "RULE_BASED",
          "default": false
        },
        {
          "type": "RELATIONAL",
          "default": true,
          "initializer": {
            "name": "nuance_BOOLEAN",
            "link": "isA"
          }
        }
      ]
    }
  ]
}

GET /v4/data-types

Retrieve the list of available data types.

Parameters

Name	In	Type	Description
includeCompatibleEntityTypes	query	boolean	When set to true, includes the compatible entity types.

Responses

Status	Meaning	Description	Schema
200	OK	List of available data types	mix.api.ListDataTypesResponse
400	Bad Request	Bad Request	Inline
401	Unauthorized	Request could not be authorized	Inline
500	Internal Server Error	Internal server error	Inline
501	Not Implemented	Feature is not yet enabled	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Builds

You create a build for your Mix.asr, Mix.nlu, and Mix.dialog resources so that you can use them in your runtime application.

A build is identified by a buildLabel, which has the following pattern:

service_projectId_buildVersion

Where:

• service is one of ASR, NLU, or DIALOG
• projectId is the ID of the project for which the builds were created
• buildVersion is the version of the build

For example:

• NLU_11624_2
• DIALOG_525_2

For more information about builds, see Create builds.

Start a build

Body parameter

{
  "asr": {
    "notes": "string"
  },
  "dialog": {
    "notes": "string"
  },
  "nlu": {
    "notes": "string",
    "settings": {
      "modelType": "LEGACY"
    }
  },
  "locales": [
    "string"
  ]
}

Example responses

Job successfully created

{
  "id": "00685149-888e-47fc-b529-b8eb8e3bc530",
  "type": "BUILD_MODELS",
  "projectId": "26089",
  "status": "RUNNING",
  "createTime": "2022-01-17T16:29:54Z",
  "updateTime": "2022-01-17T16:29:54Z"
}

POST /v4/projects/{projectId}/.build

Start ASR, NLU, and/or dialog builds for a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.
body	body	mix.api.BuildProjectModelBody	Message that defines the builds to start.

Responses

Status	Meaning	Description	Schema
200	OK	Job successfully created	mix.api.JobResponse
400	Bad Request	Bad request	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Project not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get builds

Example responses

200 Response

{
  "projectId": "23079",
  "builds": [
    {
      "projectId": "23079",
      "buildLabel": "NLU_23079_1",
      "buildId": "1955",
      "buildType": "NLU",
      "buildVersion": "1",
      "status": "BST_COMPLETED",
      "languageTopic": "gen",
      "datapack": {
        "displayName": "en-US",
        "version": "4.7.0"
      },
      "notes": "First build",
      "createTime": "2021-01-18T16:51:42.049Z",
      "modelType": "LEGACY",
      "dataSources": [
        "nuance_custom_data"
      ]
    },
    {
      "projectId": "23079",
      "buildLabel": "NLU_23079_2",
      "buildId": "1956",
      "buildType": "NLU",
      "buildVersion": "2",
      "status": "BST_COMPLETED",
      "languageTopic": "gen",
      "datapack": {
        "displayName": "en-US",
        "version": "4.7.0"
      },
      "notes": "Update for ASR and NLU only",
      "createTime": "2021-01-18T16:56:04.140Z",
      "modelType": "LEGACY",
      "dataSources": [
        "nuance_custom_data"
      ]
    }
  ],
  "totalSize": 2,
  "count": 2,
  "limit": 10,
  "offset": 0
}

GET /v4/projects/{projectId}/builds

Retrieve the list of all ASR, NLU, or dialog builds for a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.
type	query	string	Type of build.
limit	query	integer(int32)	Maximum number of query results returned.
offset	query	integer(int32)	Offset to use when returning results.
sortBy	query	array[string]	Sort parameter; use the format: +buildId.

Detailed descriptions

type: Type of build.

• NLU: NLU build
• ASR: ASR build
• DIALOG: Dialog build

Responses

Status	Meaning	Description	Schema
200	OK	List of builds	mix.api.ListBuildsResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get latest builds

Example responses

200 Response

{
  "models": {
    "asr": {
      "builds": [
        {
          "locale": "en-US",
          "buildVersion": "6",
          "buildLabel": "ASR_23079_6"
        }
      ],
      "projectId": "23079"
    },
    "nlu": {
      "builds": [
        {
          "locale": "en-US",
          "buildVersion": "6",
          "buildLabel": "NLU_23079_6"
        }
      ],
      "projectId": "23079"
    },
    "dialog": {
      "projectId": "23079",
      "buildVersion": "7",
      "buildLabel": "DIALOG_23079_7"
    }
  }
}

GET /v4/projects/{projectId}/builds/.latest

Retrieve the latest ASR, NLU, and dialog builds for a project.

Parameters

Name	In	Type	Description
projectId	path	string	ID of the project.

Responses

Status	Meaning	Description	Schema
200	OK	Latest builds for a project	mix.api.ListLatestBuildsResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get build details

Example responses

200 Response

{
  "projectId": "11624",
  "buildLabel": "NLU_11624_1",
  "buildId": "463",
  "buildType": "NLU",
  "buildVersion": "1",
  "status": "BST_COMPLETED",
  "languageTopic": "gen",
  "datapack": {
    "displayName": "en-US",
    "version": "4.5.0"
  },
  "notes": "",
  "createTime": "2020-05-06T19:02:09.262Z",
  "modelType": "LEGACY"
}

GET /v4/builds/{buildLabel}

Retrieve the details of a build.

Parameters

Name	In	Type	Description
buildLabel	path	string	Build display name, identified with buildLabel.

Responses

Status	Meaning	Description	Schema
200	OK	Build details	mix.api.GetBuildResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Delete a build

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

DELETE /v4/builds/{buildLabel}

Delete a build.

Parameters

Name	In	Type	Description
buildLabel	path	string	Build display name, identified with buildLabel.

Responses

Status	Meaning	Description	Schema
200	OK	Build successfully deleted	google.rpc.Status
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Download a build

GET /v4/builds/{buildLabel}/.download

Download the build resources.

Parameters

Name	In	Type	Description
buildLabel	path	string	Display name of the build to be downloaded, identified with buildLabel.

Responses

Status	Meaning	Description	Schema
200	OK	Build resource	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Data Hosts

If a dialog project exchanges data with an external system using a server-side integration, you need to configure a data host for this project.

A data host provides information about the web service that will handle the data requests, such as the URL of the web service, an alias, and so on.

For more information about configuring data hosts, see Exchange data with an external system.

Get data hosts

Example responses

200 Response

{
  "dataHosts": [
    {
      "id": "200",
      "alias": "COFFEE_APP",
      "environmentId": "57",
      "environmentGeographyId": "1",
      "value": "https://coffee.app.com:443"
    }
  ]
}

GET /v4/builds/{buildLabel}/data-hosts

Retrieve the list of data hosts for the build and application specified.

Parameters

Name	In	Type	Description
buildLabel	path	string	Dialog build display name, identified with buildLabel, for which to get the list of data hosts.
applicationId	query	string	ID of the Mix application for which to get the list of data hosts.
deploymentFlowId	query	string	ID of the deployment flow for which to return data hosts.

Responses

Status	Meaning	Description	Schema
200	OK	List of data hosts	mix.api.ListDataHostsResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get latest data hosts

Example responses

200 Response

{
  "dataHosts": [
    {
      "id": "200",
      "alias": "COFFEE_APP",
      "environmentId": "39",
      "environmentGeographyId": "1",
      "value": "https://coffee.app.com:443"
    },
    {
      "id": "518",
      "alias": "LOCAL",
      "environmentId": "39",
      "environmentGeographyId": "1",
      "value": "http://dataaccess-examples.local/dataaccess-examples/"
    }
  ]
}

GET /v4/apps/{applicationId}/projects/{projectId}/data-hosts/.latest

Retrieve the list of the data hosts associated with the last generated dialog build.

Parameters

Name	In	Type	Description
applicationId	path	string	ID of the Mix application for which to get the list of data hosts.
projectId	path	string	ID of the project for which to return data hosts.
deploymentFlowId	query	string	ID of the deployment flow for which to return data hosts.

Responses

Status	Meaning	Description	Schema
200	OK	List of data hosts	mix.api.ListLatestDataHostsResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Applications

Mix applications

* Omni-Channel Application

App IDs

* Development
  - appId: DEMO-OMNICHANNEL-APP-DEV
* QA
  - appId: DEMO-OMNICHANNEL-APP-QA
* Staging
  - appId: DEMO-OMNICHANNEL-APP-STAGE
* Production
  - appId: DEMO-OMNICHANNEL-APP-PROD

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

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.co.uk"
                  },
                  "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 /v4/organizations/{orgId}/apps

Retrieve the list of Mix applications available in the organization specified.

Parameters

Name	In	Type	Description
orgId	path	string	ID of the organization for which to get the list of applications.
view	query	string	Application view to return.
appId	query	string	Runtime app ID to filter the results; for example, NMDPTRIAL_alex_smith_company_com_20190919T190532.

Detailed descriptions

view: Application view to return.

• AV_VIEW_UNSPECIFIED: Returns application details without including application configurations
• AV_FULL: Returns all application details, including the list of application configurations
• AV_FULL_AVAILABLE_CONFIGS: Returns all application details, omitting configs that are overridden
• AV_FULL_LIVE_CONFIGS: Returns all application configs that are deployed

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

Get list of Mix applications

Example responses

200 Response

{
  "applications": [
    {
      "id": "48",
      "applicationName": "Mix Sample App",
      "organizationId": "3",
      "organizationName": "json.smith@nuance.co.uk",
      "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.co.uk"
                  },
                  "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 /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.

Parameters

Name	In	Type	Description
orgId	query	string	ID of the organization for which to get the list of applications.
view	query	string	Application view to return.
appId	query	string	Runtime app ID to filter the results; for example, NMDPTRIAL_alex_smith_company_com_20190919T190532.
limit	query	string	Maximum number of query results returned.
offset	query	string	Offset to use when returning results.
filter	query	string	Filter results parameter: can be application ID or application display name. The search is case sensitive.

Detailed descriptions

view: Application view to return.

• AV_VIEW_UNSPECIFIED: Returns application details without including application configurations
• AV_FULL: Returns all application details, including the list of application configurations
• AV_FULL_AVAILABLE_CONFIGS: Returns all application details, omitting configs that are overridden
• AV_FULL_LIVE_CONFIGS: Returns all application configs that are deployed

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

Get application credentials

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.co.uk"
        }
      ],
      "createTime": "2020-01-16T15:44:26.008Z",
      "updateTime": "2020-10-23T02:44:57.157Z"
    }
  ]
}

GET /v4/apps/{applicationId}/credentials

Retrieve the list of application credentials that correspond to the query criteria specified.

Parameters

Name	In	Type	Description
applicationId	path	string	ID of the Mix application for which to get the list of credentials.
envGeographyName	query	string	Name of the environment geography; for example, US.
view	query	string	Application credentials view to return.

Detailed descriptions

view: Application credentials view to return.

• ACV_VIEW_UNSPECIFIED: Returns credentials details without including clients
• ACV_FULL: Returns all credentials details, including list of clients

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

Application Configurations

An application configuration associates an app ID with the Mix.asr, Mix.nlu, and Mix.dialog resources deployed in a runtime environment.

An application with configurations that include dialog builds is a bot.

For more information, see Creating and deploying applications.

Get list of application configurations

Example responses

200 Response

{
  "configs": [
    {
      "id": "670",
      "tag": "A35_C670",
      "deployments": [
        {
          "id": "38",
          "status": "DEPLOYED",
          "envGeographyDeployments": [
            {
              "id": "645",
              "envGeography": {
                "id": "37",
                "geography": {
                  "id": "1",
                  "displayName": "US"
                },
                "envType": "SANDBOX",
                "envHost": "api.nuance.co.uk",
                "envName": "Sandbox"
              },
              "status": "DEPLOYED",
              "deploymentResult": "success",
              "isOverridden": false,
              "dataHosts": []
            }
          ]
        }
      ],
      "parentId": "",
      "deploymentFlowId": 38,
      "builds": {
        "asr": {
          "builds": [
            {
              "locale": "fr-FR",
              "buildVersion": "1",
              "buildLabel": "ASR_17100_1",
              "createTime": "2020-07-16T20:40:15Z"
            },
            {
              "locale": "en-US",
              "buildVersion": "2",
              "buildLabel": "ASR_17100_2",
              "createTime": "2020-07-16T20:40:25Z"
            }
          ],
          "projectId": "17100"
        },
        "nlu": {
          "builds": [
            {
              "locale": "fr-FR",
              "buildVersion": "1",
              "buildLabel": "NLU_17100_1",
              "createTime": "2020-07-16T20:40:11Z"
            },
            {
              "locale": "en-US",
              "buildVersion": "2",
              "buildLabel": "NLU_17100_2",
              "createTime": "2020-07-16T20:40:20Z"
            }
          ],
          "projectId": "17100"
        }
      },
      "projectDetails": {
        "projectId": "17100",
        "projectName": "CoffeeApp MultiLang",
        "isChildDataCompliant": true,
        "projectDescription": ""
      },
      "createTime": "2020-07-20T18:38:22Z"
    }
  ],
  "totalSize": 1
}

GET /v4/apps/{applicationId}/app-configs

Retrieve the list of application configurations available in the Mix application specified.

Parameters

Name	In	Type	Description
applicationId	path	string	ID of the Mix application for which to get the list of configurations.
tag	query	string	Context tag name to filter the results.
appId	query	string	Runtime app ID to filter the results; for example, NMDPTRIAL_alex_smith_company_com_20190919T190532.
excludeOverrides	query	boolean	When set to true, application configurations that are overridden are excluded from the list.
liveOnly	query	boolean	When set to true, returns only the application configurations that are currently deployed.

Responses

Status	Meaning	Description	Schema
200	OK	List of application configurations	mix.api.ListApplicationConfigsResponse
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

Create an application configuration

Body parameter

{
  "dataHosts": [
    {
      "id": "string",
      "alias": "string",
      "environmentId": "string",
      "environmentGeographyId": "string",
      "value": "string"
    }
  ],
  "deploymentFlowId": "string",
  "tag": "string",
  "requestBuilds": {
    "asr": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "nlu": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "dialog": {
      "buildLabel": "string"
    }
  }
}

Example responses

200 Response

{
  "config": {
    "id": "2097",
    "tag": "billing_application",
    "deployments": [
      {
        "id": "38",
        "status": "PENDING_REQUEST",
        "envGeographyDeployments": []
      }
    ],
    "parentId": "null",
    "deploymentFlowId": 38,
    "createTime": "2021-04-21T19:45:44.809Z"
  }
}

POST /v4/apps/{applicationId}/app-configs

Create a new application configuration.

Parameters

Name	In	Type	Description
applicationId	path	string	ID of Mix application under which the configuration will be created.
useLatestFromProject	query	string	Specify a project ID to use the latest models that were built for this project. If useLatestFromProject is specified, the models set in the body field will be ignored.
buildTypes	query	array[string]	Use only the build types specified. Applies only when useLatestFromProject is set.
locales	query	array[string]	Use only the build locales specified, where applicable. Applies only when useLatestFromProject is set.
useProjectDefault	query	boolean	When set to true, the default data hosts will be used, where applicable.
body	body	mix.api.ApplicationConfigContent	Application configuration to create.

Detailed descriptions

buildTypes: Use only the build types specified. Applies only when useLatestFromProject is set.

• NLU: NLU build
• ASR: ASR build
• DIALOG: Dialog build

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully created	mix.api.CreateApplicationConfigResponse
400	Bad Request	Request contains invalid arguments	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Application not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Get application configuration

Example responses

200 Response

{
  "config": {
    "id": "670",
    "tag": "A35_C670",
    "deployments": [
      {
        "id": "38",
        "status": "DEPLOYED",
        "envGeographyDeployments": [
          {
            "id": "645",
            "envGeography": {
              "id": "37",
              "geography": {
                "id": "1",
                "displayName": "US"
              },
              "envType": "SANDBOX",
              "envHost": "api.nuance.co.uk",
              "envName": "Sandbox"
            },
            "status": "DEPLOYED",
            "deploymentResult": "success",
            "isOverridden": false,
            "dataHosts": []
          }
        ]
      }
    ],
    "parentId": "",
    "deploymentFlowId": 38,
    "builds": {
      "asr": {
        "builds": [
          {
            "locale": "en-US",
            "buildVersion": "2",
            "buildLabel": "ASR_17100_2",
            "createTime": "2020-07-16T20:40:25Z"
          },
          {
            "locale": "fr-FR",
            "buildVersion": "1",
            "buildLabel": "ASR_17100_1",
            "createTime": "2020-07-16T20:40:15Z"
          }
        ],
        "projectId": "17100"
      },
      "nlu": {
        "builds": [
          {
            "locale": "en-US",
            "buildVersion": "2",
            "buildLabel": "NLU_17100_2",
            "createTime": "2020-07-16T20:40:20Z"
          },
          {
            "locale": "fr-FR",
            "buildVersion": "1",
            "buildLabel": "NLU_17100_1",
            "createTime": "2020-07-16T20:40:11Z"
          }
        ],
        "projectId": "17100"
      }
    },
    "projectDetails": {
      "projectId": "17100",
      "projectName": "CoffeeApp MultiLang",
      "isChildDataCompliant": true,
      "projectDescription": ""
    },
    "createTime": "2020-07-20T18:38:22Z"
  }
}

GET /v4/app-configs/{configId}

Retrieve an application configuration.

Parameters

Name	In	Type	Description
configId	path	string	ID of configuration to get.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration	mix.api.GetApplicationConfigResponse
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

Delete an application configuration

Example responses

200 Response

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

DELETE /v4/app-configs/{configId}

Delete an application configuration.

Parameters

Name	In	Type	Description
configId	path	string	ID of application configuration to delete.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully deleted	google.rpc.Status
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Application configuration not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Override an existing application configuration

Body parameter

{
  "dataHosts": [
    {
      "id": "string",
      "alias": "string",
      "environmentId": "string",
      "environmentGeographyId": "string",
      "value": "string"
    }
  ],
  "requestModels": {
    "asr": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "nlu": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "dialog": {
      "buildLabel": "string"
    }
  }
}

Example responses

200 Response

{
  "config": {
    "id": "string",
    "tag": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "deployments": [
      {
        "id": "string",
        "status": "STATUS_UNSPECIFIED",
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z",
        "envGeographyDeployments": [
          {
            "id": null,
            "envGeography": null,
            "status": null,
            "deploymentResult": null,
            "isOverridden": null,
            "requestedBy": null,
            "approvedBy": null,
            "dataHosts": null,
            "createdAt": null,
            "approvedAt": null,
            "approvalRequired": null
          }
        ]
      }
    ],
    "parentId": "string",
    "deploymentFlowId": 0,
    "builds": {
      "asr": {
        "builds": [
          {}
        ],
        "projectId": "string"
      },
      "nlu": {
        "builds": [
          {}
        ],
        "projectId": "string"
      },
      "dialog": {
        "projectId": "string",
        "buildVersion": "string",
        "buildLabel": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    },
    "projectDetails": {
      "projectId": "string",
      "projectName": "string",
      "isChildDataCompliant": true,
      "projectDescription": "string"
    }
  }
}

POST /v4/app-configs/{configId}/.override

Override an existing application configuration.

Parameters

Name	In	Type	Description
configId	path	string	ID of application configuration to override.
latest	query	boolean	When set to true, use the latest models from the project associated with the existing configuration or from the project specified in useLatestFromProject. If latest is specified, the models set in the body field will be ignored.
buildTypes	query	array[string]	Use only the build types specified. Applies only when latest is set to true.
locales	query	array[string]	Use only the build locales specified, where applicable. Applies only when latest is set to true.
useLatestFromProject	query	string	Specify a project ID to use the latest models that were built for this project. Applies only when latest is set to true.
useProjectDefault	query	boolean	When set to true, use the default data hosts, where applicable.
body	body	mix.api.OverrideApplicationConfigContent	Content that will override the existing application configuration.

Detailed descriptions

buildTypes: Use only the build types specified. Applies only when latest is set to true.

• NLU: NLU build
• ASR: ASR build
• DIALOG: Dialog build

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully overridden	mix.api.OverrideApplicationConfigResponse
400	Bad Request	Request contains invalid arguments	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Application configuration not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Download an application configuration

GET /v4/app-configs/{configId}/.download

Download the contents of an application configuration that is currently deployed in an environment.

Parameters

Name	In	Type	Description
configId	path	string	ID of the deployed application configuration to download.
appId	query	string	Runtime app ID where the configuration is deployed; for example, NMDPTRIAL_alex_smith_company_com_20190919T190532.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration (zip file, with application/octet-stream content-type)	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Deploy an application configuration

Example responses

200 Response

{
  "deployments": [
    {
      "id": "1425",
      "configId": "2101",
      "approved": true,
      "comment": "",
      "promotionFlowStepId": "38",
      "code": 0,
      "createTime": "2021-04-22T18:37:38.806Z",
      "updateTime": "2021-04-22T18:37:38.806Z"
    }
  ]
}

PUT /v4/app-configs/{configId}/.deploy

Deploy an application configuration.

Parameters

Name	In	Type	Description
configId	path	string	ID of application configuration to deploy.
environmentGeographyIds	query	array[string]	List of environment geography IDs where to deploy the configuration.
body	body	object	Leave this body empty.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully deployed	mix.api.DeployApplicationConfigResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Undeploy application configuration

Example responses

200 Response

{
  "undeployments": [
    {
      "configId": "2101",
      "applicationConfigDeploymentId": "1425",
      "environmentGeographyId": "37",
      "code": 0,
      "message": "App config undeployed."
    }
  ]
}

PUT /v4/app-configs/{configId}/.undeploy

Undeploy an application configuration.

Parameters

Name	In	Type	Description
configId	path	string	ID of application configuration to undeploy.
environmentGeographyIds	query	array[string]	List of environment geography IDs from which to undeploy the configuration.
body	body	object	Leave this body empty.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration undeployment status	mix.api.UndeployApplicationConfigResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Schemas

mix.api.ASRBody

mix.api.ASRBody schema

{
  "notes": "string"
}

Message that defines an ASR build.

Properties

Name	Type	Description
notes	string	Notes specified when starting the build.

mix.api.AnaphoraType

mix.api.AnaphoraType schema

"ANAPHORA_NOT_SET"

Type of anaphora entity.

• ANAPHORA_NOT_SET: No anaphora type defined
• ANAPHORA_REF_MOMENT: References a time
• ANAPHORA_REF_PERSON: References a person
• ANAPHORA_REF_PLACE: References a place
• ANAPHORA_REF_THING: References a thing

mix.api.AppConfigDeployment

mix.api.AppConfigDeployment schema

{
  "id": "string",
  "status": "STATUS_UNSPECIFIED",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "envGeographyDeployments": [
    {
      "id": "string",
      "envGeography": {
        "id": "string",
        "geography": {
          "id": "string",
          "displayName": "string"
        },
        "envType": "EST_TYPE_UNSPECIFIED",
        "envHost": "string",
        "envName": "string"
      },
      "status": "STATUS_UNSPECIFIED",
      "deploymentResult": "string",
      "isOverridden": true,
      "requestedBy": {
        "id": "string",
        "email": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "lastLoginTime": "2019-08-24T14:15:22Z",
        "name": "string"
      },
      "approvedBy": {
        "id": "string",
        "email": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "lastLoginTime": "2019-08-24T14:15:22Z",
        "name": "string"
      },
      "dataHosts": [
        {
          "id": "string",
          "alias_id": "string",
          "alias": "string",
          "value": "string"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "approvedAt": "2019-08-24T14:15:22Z",
      "approvalRequired": true
    }
  ]
}

Message that defines a deployment for an application configuration.

Properties

Name	Type	Description
id	string	Unique ID identifying the deployment.
status	mix.api.DeploymentFlowStatus	Status of the deployment.
createTime	string(date-time)	Date and time the deployment was created.
updateTime	string(date-time)	Date and time the deployment was last updated.
envGeographyDeployments	[mix.api.EnvironmentGeographyAppConfigDeployment]	List of environment geographies where the application configuration was deployed.

mix.api.AppCredential

mix.api.AppCredential schema

{
  "id": "string",
  "appId": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "clients": [
    {
      "id": "string",
      "clientId": "string",
      "clientName": "string",
      "oauthScopes": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "updateTime": "2019-08-24T14:15:22Z"
    }
  ]
}

Message that defines credentials.

Properties

Name	Type	Description
id	string	Unique ID identifying the credentials.
appId	string	Credentials name (that is, the runtime app ID).
createTime	string(date-time)	Date and time the credentials were created.
updateTime	string(date-time)	Date and time the credentials were last updated.
clients	[mix.api.AppCredentialClient]	List of clients.

mix.api.AppCredentialClient

mix.api.AppCredentialClient schema

{
  "id": "string",
  "clientId": "string",
  "clientName": "string",
  "oauthScopes": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z"
}

Message that defines defines a client.

Properties

Name	Type	Description
id	string	Unique numeric ID identifying the client.
clientId	string	Client ID used for authorization.
clientName	string	Client name.
oauthScopes	string	List of scopes granted to this client.
createTime	string(date-time)	Date and time the client was created.
updateTime	string(date-time)	Date and time the client was last updated.

mix.api.AppCredentialView

mix.api.AppCredentialView schema

"ACV_VIEW_UNSPECIFIED"

Input field that specifies the application credentials information returned.

• ACV_VIEW_UNSPECIFIED: Returns credentials details without including clients
• ACV_FULL: Returns all credentials details, including list of clients

mix.api.Application

mix.api.Application schema

{
  "id": "string",
  "applicationName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "configs": [
    {
      "id": "string",
      "tag": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "deployments": [
        {
          "id": "string",
          "status": "STATUS_UNSPECIFIED",
          "createTime": "2019-08-24T14:15:22Z",
          "updateTime": "2019-08-24T14:15:22Z",
          "envGeographyDeployments": [
            {}
          ]
        }
      ],
      "parentId": "string",
      "deploymentFlowId": 0,
      "builds": {
        "asr": {
          "builds": [
            null
          ],
          "projectId": "string"
        },
        "nlu": {
          "builds": [
            null
          ],
          "projectId": "string"
        },
        "dialog": {
          "projectId": "string",
          "buildVersion": "string",
          "buildLabel": "string",
          "createTime": "2019-08-24T14:15:22Z"
        }
      },
      "projectDetails": {
        "projectId": "string",
        "projectName": "string",
        "isChildDataCompliant": true,
        "projectDescription": "string"
      }
    }
  ]
}

Message that defines a Mix application.

Properties

Name	Type	Description
id	string	Unique ID identifying the application in the organization.
applicationName	string	Name of the application.
createTime	string(date-time)	Date and time the application was created.
configs	[mix.api.ApplicationConfig]	List of application configurations.

mix.api.ApplicationConfig

mix.api.ApplicationConfig schema

{
  "id": "string",
  "tag": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "deployments": [
    {
      "id": "string",
      "status": "STATUS_UNSPECIFIED",
      "createTime": "2019-08-24T14:15:22Z",
      "updateTime": "2019-08-24T14:15:22Z",
      "envGeographyDeployments": [
        {
          "id": "string",
          "envGeography": {
            "id": null,
            "geography": null,
            "envType": null,
            "envHost": null,
            "envName": null
          },
          "status": "STATUS_UNSPECIFIED",
          "deploymentResult": "string",
          "isOverridden": true,
          "requestedBy": {
            "id": null,
            "email": null,
            "createTime": null,
            "lastLoginTime": null,
            "name": null
          },
          "approvedBy": {
            "id": null,
            "email": null,
            "createTime": null,
            "lastLoginTime": null,
            "name": null
          },
          "dataHosts": [
            {}
          ],
          "createdAt": "2019-08-24T14:15:22Z",
          "approvedAt": "2019-08-24T14:15:22Z",
          "approvalRequired": true
        }
      ]
    }
  ],
  "parentId": "string",
  "deploymentFlowId": 0,
  "builds": {
    "asr": {
      "builds": [
        {
          "locale": "string",
          "buildVersion": "string",
          "buildLabel": "string",
          "createTime": "2019-08-24T14:15:22Z"
        }
      ],
      "projectId": "string"
    },
    "nlu": {
      "builds": [
        {
          "locale": "string",
          "buildVersion": "string",
          "buildLabel": "string",
          "createTime": "2019-08-24T14:15:22Z"
        }
      ],
      "projectId": "string"
    },
    "dialog": {
      "projectId": "string",
      "buildVersion": "string",
      "buildLabel": "string",
      "createTime": "2019-08-24T14:15:22Z"
    }
  },
  "projectDetails": {
    "projectId": "string",
    "projectName": "string",
    "isChildDataCompliant": true,
    "projectDescription": "string"
  }
}

Message that defines an application configuration.

Properties

Name	Type	Description
id	string	Unique ID identifying the application configuration.
tag	string	Context tag for the application configuration.
createTime	string(date-time)	Date and time the application configuration was created.
deployments	[mix.api.AppConfigDeployment]	List of deployments for this application configuration.
parentId	string	ID of the parent application configuration, when an application configuration was overridden.
deploymentFlowId	integer(int32)	ID of the configuration's deployment flow.
builds	mix.api.ModelsContent	List of builds for this application configuration.
projectDetails	mix.api.ProjectDetails	Project details.

mix.api.ApplicationConfigContent

mix.api.ApplicationConfigContent schema

{
  "dataHosts": [
    {
      "id": "string",
      "alias": "string",
      "environmentId": "string",
      "environmentGeographyId": "string",
      "value": "string"
    }
  ],
  "deploymentFlowId": "string",
  "tag": "string",
  "requestBuilds": {
    "asr": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "nlu": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "dialog": {
      "buildLabel": "string"
    }
  }
}

Message that defines the application configuration to create.

Properties

Name	Type	Description
dataHosts	[mix.api.DataHost]	List of data hosts to use for this application configuration.
deploymentFlowId	string	ID of the deployment flow to use for this application configuration.
tag	string	Application configuration context tag.
requestBuilds	mix.api.RequestModelsContent	List of models for this application configuration.

mix.api.ApplicationConfigDeployment

mix.api.ApplicationConfigDeployment schema

{
  "id": "string",
  "configId": "string",
  "approved": true,
  "comment": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "promotionFlowStepId": "string",
  "code": 0
}

Message that defines an application configuration deployment.

Properties

Name	Type	Description
id	string	Deployment ID.
configId	string	ID of application configuration.
approved	boolean	Approval status.
comment	string	Notes about the deployment, if any.
createTime	string(date-time)	Date and time the deployment was created.
updateTime	string(date-time)	Date and time the deployment was last updated.
promotionFlowStepId	string	Deployment flow step ID for this deployment.
code	integer(int32)	Deployment status gRPC code. See Status codes and their use in gRPC for a list of valid codes.

mix.api.ApplicationConfigUndeployment

mix.api.ApplicationConfigUndeployment schema

{
  "configId": "string",
  "applicationConfigDeploymentId": "string",
  "environmentGeographyId": "string",
  "code": 0,
  "message": "string"
}

Message that defines an application configuration that was undeployed.

Properties

Name	Type	Description
configId	string	ID of application configuration that was undeployed.
applicationConfigDeploymentId	string	Deployment ID.
environmentGeographyId	string	ID of the environment geography from which the application configuration was undeployed.
code	integer(int32)	Undeployment status code.
message	string	Undeployment status message.

mix.api.ApplicationCredential

mix.api.ApplicationCredential schema

{
  "id": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "credential": {
    "id": "string",
    "appId": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "clients": [
      {
        "id": "string",
        "clientId": "string",
        "clientName": "string",
        "oauthScopes": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "geographies": [
    {
      "id": "string",
      "geography": {
        "id": "string",
        "displayName": "string"
      },
      "envType": "EST_TYPE_UNSPECIFIED",
      "envHost": "string",
      "envName": "string"
    }
  ]
}

Message that defines a list of credentials for an application.

Properties

Name	Type	Description
id	string	Unique ID identifying the list of credentials for an application.
createTime	string(date-time)	Date and time the list of credentials was created.
updateTime	string(date-time)	Date and time the list of credentials was last updated.
credential	mix.api.AppCredential	List of credentials for the application.
geographies	[mix.api.EnvironmentGeography]	List of environment geographies for the application.

mix.api.ApplicationView

mix.api.ApplicationView schema

"AV_VIEW_UNSPECIFIED"

Input field that specifies the application information returned.

• AV_VIEW_UNSPECIFIED: Returns application details without including application configurations
• AV_FULL: Returns all application details, including the list of application configurations
• AV_FULL_AVAILABLE_CONFIGS: Returns all application details, omitting configs that are overridden
• AV_FULL_LIVE_CONFIGS: Returns all application configs that are deployed

mix.api.BaseBuildContent

mix.api.BaseBuildContent schema

{
  "locale": "string",
  "buildVersion": "string",
  "buildLabel": "string",
  "createTime": "2019-08-24T14:15:22Z"
}

Message that defines the content of an ASR or NLU build.

Properties

Name	Type	Description
locale	string	Build locale.
buildVersion	string	Build version.
buildLabel	string	Build label.
createTime	string(date-time)	Date and time the build was created.

mix.api.BaseEntity

mix.api.BaseEntity schema

{
  "id": "string",
  "name": "string",
  "dataType": "NOT_SET"
}

Type for entities that are included by default with any NLU project. These are read-only.

Properties

Name	Type	Description
id	string	UUID of the entity.
name	string	Entity name.
dataType	mix.api.DataType	Data type for the entity.

mix.api.BaseModelContent

mix.api.BaseModelContent schema

{
  "builds": [
    {
      "locale": "string",
      "buildVersion": "string",
      "buildLabel": "string",
      "createTime": "2019-08-24T14:15:22Z"
    }
  ],
  "projectId": "string"
}

Message that defines an ASR or NLU model.

Properties

Name	Type	Description
builds	[mix.api.BaseBuildContent]	List of builds.
projectId	string	ID of the project for these builds.

mix.api.BaseRequestModelContent

mix.api.BaseRequestModelContent schema

{
  "buildLabel": "string",
  "locale": "string"
}

Message that defines a base request model.

Properties

Name	Type	Description
buildLabel	string	Display name of the build.
locale	string	Build locale.

mix.api.Bot

mix.api.Bot schema

{
  "id": "string",
  "applicationName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "configs": [
    {
      "id": "string",
      "tag": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "deployments": [
        {
          "id": "string",
          "status": "STATUS_UNSPECIFIED",
          "createTime": "2019-08-24T14:15:22Z",
          "updateTime": "2019-08-24T14:15:22Z",
          "envGeographyDeployments": [
            {}
          ]
        }
      ],
      "parentId": "string",
      "hasInterface": true,
      "deploymentFlowId": 0
    }
  ]
}

Message that defines a bot.

Properties

Name	Type	Description
id	string	Unique ID identifying the bot in the organization.
applicationName	string	Name of the bot.
createTime	string(date-time)	Date and time the bot was created.
configs	[mix.api.BotConfig]	List of application configurations for this bot.

mix.api.BotConfig

mix.api.BotConfig schema

{
  "id": "string",
  "tag": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "deployments": [
    {
      "id": "string",
      "status": "STATUS_UNSPECIFIED",
      "createTime": "2019-08-24T14:15:22Z",
      "updateTime": "2019-08-24T14:15:22Z",
      "envGeographyDeployments": [
        {
          "id": "string",
          "envGeography": {
            "id": null,
            "geography": null,
            "envType": null,
            "envHost": null,
            "envName": null
          },
          "status": "STATUS_UNSPECIFIED",
          "deploymentResult": "string",
          "isOverridden": true,
          "requestedBy": {
            "id": null,
            "email": null,
            "createTime": null,
            "lastLoginTime": null,
            "name": null
          },
          "approvedBy": {
            "id": null,
            "email": null,
            "createTime": null,
            "lastLoginTime": null,
            "name": null
          },
          "dataHosts": [
            {}
          ],
          "createdAt": "2019-08-24T14:15:22Z",
          "approvedAt": "2019-08-24T14:15:22Z",
          "approvalRequired": true
        }
      ]
    }
  ],
  "parentId": "string",
  "hasInterface": true,
  "deploymentFlowId": 0
}

Message that defines an application configuration for a bot.

Properties

Name	Type	Description
id	string	Unique ID identifying the application configuration for the bot.
tag	string	Context tag for the application configuration.
createTime	string(date-time)	Date and time the application configuration was created.
deployments	[mix.api.AppConfigDeployment]	List of deployments for this application configuration.
parentId	string	ID of the parent application configuration, when an application configuration was overridden.
hasInterface	boolean	Boolean indicating whether the application configuration has a dialog interface.
deploymentFlowId	integer(int32)	ID of the configuration's deployment flow.

mix.api.BotConfigInterface

mix.api.BotConfigInterface schema

{
  "id": "string",
  "version": 0,
  "createTime": "2019-08-24T14:15:22Z",
  "languageTopic": "string",
  "locales": [
    "string"
  ],
  "channels": [
    {
      "id": "string",
      "displayName": "string",
      "codeName": "string",
      "modes": [
        "MODE_UNSPECIFIED"
      ],
      "color": "COLOR_UNSPECIFIED"
    }
  ],
  "variables": [
    {
      "id": "string",
      "displayName": "string",
      "description": "string",
      "isReserved": true,
      "simpleVariableType": "VT_TYPE_UNSPECIFIED",
      "complexVariableTypeId": "string",
      "simpleGenericType": "VT_TYPE_UNSPECIFIED",
      "complexGenericTypeId": "string"
    }
  ],
  "transferNodes": [
    {
      "id": "string",
      "nodeName": "string",
      "nodeType": "TNT_TYPE_UNSPECIFIED",
      "description": "string",
      "requestVariables": [
        {
          "id": "string",
          "displayName": "string",
          "description": "string",
          "isReserved": true,
          "simpleVariableType": "VT_TYPE_UNSPECIFIED",
          "complexVariableTypeId": "string",
          "simpleGenericType": "VT_TYPE_UNSPECIFIED",
          "complexGenericTypeId": "string"
        }
      ]
    }
  ]
}

Message that defines a bot configuration interface.

Properties

Name	Type	Description
id	string	Unique ID identifying the configuration interface.
version	integer(int32)	Version of the dialog build.
createTime	string(date-time)	Date and time the configuration interface was created.
languageTopic	string	Topic domain of the ASR data pack.
locales	[string]	List of locales in the bot.
channels	[mix.api.Channel]	List of channels in the bot.
variables	[mix.api.Variable]	List of variables in the bot.
transferNodes	[mix.api.TransferNode]	List of transfer nodes in the bot.

mix.api.BotCredential

mix.api.BotCredential schema

{
  "id": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "credential": {
    "id": "string",
    "appId": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "clients": [
      {
        "id": "string",
        "clientId": "string",
        "clientName": "string",
        "oauthScopes": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "geographies": [
    {
      "id": "string",
      "geography": {
        "id": "string",
        "displayName": "string"
      },
      "envType": "EST_TYPE_UNSPECIFIED",
      "envHost": "string",
      "envName": "string"
    }
  ]
}

Message that defines a list of credentials for a bot.

Properties

Name	Type	Description
id	string	Unique ID identifying the list of credentials for a bot.
createTime	string(date-time)	Date and time the list of credentials was created.
updateTime	string(date-time)	Date and time the list of credentials was last updated.
credential	mix.api.AppCredential	List of credentials for the bot.
geographies	[mix.api.EnvironmentGeography]	List of environment geographies for the bot.

mix.api.BotCredentialView

mix.api.BotCredentialView schema

"BCV_VIEW_UNSPECIFIED"

Input field that specifies the bot credentials information returned.

• BCV_VIEW_UNSPECIFIED: Returns credentials details without including clients
• BCV_FULL: Returns all credentials details, including list of clients

mix.api.BotView

mix.api.BotView schema

"BV_VIEW_UNSPECIFIED"

Input field that specifies the bot information returned.

• BV_VIEW_UNSPECIFIED: Returns bot details without including application configurations
• BV_FULL: Returns all bot details, including the list of application configurations
• BV_FULL_AVAILABLE_CONFIGS: Returns all bot details, omitting configs that are overridden
• BV_FULL_LIVE_CONFIGS: Returns all bot configs that are deployed

mix.api.BuildProjectModelBody

mix.api.BuildProjectModelBody schema

{
  "asr": {
    "notes": "string"
  },
  "dialog": {
    "notes": "string"
  },
  "nlu": {
    "notes": "string",
    "settings": {
      "modelType": "LEGACY"
    }
  },
  "locales": [
    "string"
  ]
}

Message that defines the builds to start.

Properties

Name	Type	Description
asr	mix.api.ASRBody	Message that defines an ASR build.
dialog	mix.api.DialogBody	Message that defines a dialog build.
nlu	mix.api.NLUBody	Message that defines an NLU build.
locales	[string]	List of locales for which to create builds.

mix.api.BuildStatusType

mix.api.BuildStatusType schema

"BST_NONE"

ENUM that defines the status of the build.

• BST_NONE: No status available
• BST_COMPLETED: Build has completed
• BST_FAILED: Build has failed
• BST_STARTED: Build has started

mix.api.BuildType

mix.api.BuildType schema

"NLU"

ENUM that defines the build type.

• NLU: NLU build
• ASR: ASR build
• DIALOG: Dialog build

mix.api.ChangeEntityTypeRequest.ChangeEntityTypeData

mix.api.ChangeEntityTypeRequest.ChangeEntityTypeData schema

{
  "newType": "UNSPECIFIED",
  "pattern": "string",
  "isA": "string",
  "hasA": {
    "entities": [
      "string"
    ]
  },
  "data": {
    "property1": {
      "entries": [
        {
          "meaning": "string",
          "patterns": [
            "string"
          ]
        }
      ]
    },
    "property2": {
      "entries": [
        {
          "meaning": "string",
          "patterns": [
            "string"
          ]
        }
      ]
    }
  },
  "dataType": "NOT_SET"
}

Object that defines the new entity type.

Properties

Name	Type	Description
newType	mix.api.ChangeEntityTypeRequest.EntityType	The type to update the entity to.
pattern	string	The regular expression pattern for a regex-based entity. Required for REGEX type; otherwise, it is ignored. Applies to all languages initially. If different patterns are needed for different languages, use the Update an entity endpoint.
isA	string	The name of the entity that this entity has an isA relationship with. Required for RELATIONAL type; otherwise, it is ignored.
hasA	mix.api.HasA	Names of the entities that this entity has a hasA relationship with. Required for RELATIONAL type; otherwise, it is ignored.
data	object	List entity data to be added; key is a valid project locale. If provided, used for LIST type; otherwise, it is ignored.
dataType	mix.api.DataType	Data type for the entity.

mix.api.ChangeEntityTypeRequest.EntityType

mix.api.ChangeEntityTypeRequest.EntityType schema

"UNSPECIFIED"

ENUM that defines the entity types.

• UNSPECIFIED: No type specified
• RELATIONAL: Relationship entity
• LIST: List entity
• FREEFORM: Freeform entity
• REGEX: Regex-based entity
• RULE_BASED: Rule-based entity

mix.api.ChangeEntityTypeResponse

mix.api.ChangeEntityTypeResponse schema

{
  "entity": {
    "freeformEntity": {
      "id": "335134db-e2f1-48b5-8abe-6dd4c0c4f98c",
      "name": "COFFEE_FLAVORS",
      "settings": {
        "isSensitive": true,
        "canonicalize": true
      }
    }
  }
}

Response object for changing an entity's type.

Properties

Name	Type	Description
entity	mix.api.EntityResponse	Response object for an entity. Only one of baseEntity, relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned.

mix.api.Channel

mix.api.Channel schema

{
  "id": "string",
  "displayName": "string",
  "codeName": "string",
  "modes": [
    "MODE_UNSPECIFIED"
  ],
  "color": "COLOR_UNSPECIFIED"
}

Message that defines a channel.

Properties

Name	Type	Description
id	string	UUID of the channel.
displayName	string	Name of the channel.
codeName	string	Code name of the channel to use when invoking DLGaaS.
modes	[mix.api.Modality]	List of modalities available for messages in this channel.
color	mix.api.ChannelColor	Color of the channel.

mix.api.ChannelColor

mix.api.ChannelColor schema

"COLOR_UNSPECIFIED"

ENUM that defines the possible colors for a channel.

• COLOR_UNSPECIFIED: No color specified
• PURPLE: Set channel color to purple, Hex code #871699
• LIGHT_ORANGE: Set channel color to light orange, Hex code #F59E47
• GREEN: Set channel color to green, Hex code #31B96E
• CORN_FLOWER: Set channel color to corn flower, Hex code #7894F2
• PINK: Set channel color to pink, Hex code #DA2B7F
• YELLOW: Set channel color to yellow, Hex code #F8DC4F
• TEAL: Set channel color to teal, Hex code #2EB8B5
• LIGHT_GREY: Set channel color to light grey, Hex code #BDCBDB
• SALMON: Set channel color to salmon, Hex code #FE6D6D
• BROWN: Set channel color to brown, Hex code #A86315
• SKY: Set channel color to sky, Hex code #5CBCF0
• GREY: Set channel color to grey, Hex code #6D7E97
• LIGHT_PURPLE: Set channel color to light purple, Hex code #B58AF5
• RUBY: Set channel color to ruby, Hex code #C51F10
• LIGHT_GREEN: Set channel color to light green, Hex code #65DC93
• BLUE: Set channel color to blue, Hex code #2980D6
• LIGHT_PINK: Set channel color to light pink, Hex code #F67EB2
• ORANGE: Set channel color to orange, Hex code #E66819
• CYAN: Set channel color to cyan, Hex code #57DBCF
• INDIGO: Set channel color to indigo, Hex code #4E5ADA

mix.api.ChannelRequest

mix.api.ChannelRequest schema

{
  "displayName": "string",
  "modes": [
    "MODE_UNSPECIFIED"
  ],
  "color": "COLOR_UNSPECIFIED"
}

Message that defines the channels to include in a new project.

Properties

Name	Type	Description
displayName	string	Name of the channel.
modes	[mix.api.Modality]	List of modalities available for messages in this channel.
color	mix.api.ChannelColor	Color of the channel.

mix.api.ChannelTarget

mix.api.ChannelTarget schema

{
  "channel": {
    "id": "string",
    "displayName": "string",
    "codeName": "string",
    "modes": [
      "MODE_UNSPECIFIED"
    ],
    "color": "COLOR_UNSPECIFIED"
  },
  "isActive": true
}

Message that defines a channel in a project.

Properties

Name	Type	Description
channel	mix.api.Channel	Project channel.
isActive	boolean	When set to true, indicates that the channel is active.

mix.api.ChildDataCompliant

mix.api.ChildDataCompliant schema

{
  "isAccepted": true,
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "projectDescription": "string"
}

Properties

Name	Type	Description
isAccepted	boolean	When set to true, indicates the child data compliance policy was accepted for this project.
createTime	string(date-time)	Date and time the child data compliance policy was created.
updateTime	string(date-time)	Date and time the child data compliance policy was last updated.
projectDescription	string	Child data compliance policy description for this project.

mix.api.CompatibleEntityType

mix.api.CompatibleEntityType schema

{
  "name": "UNSPECIFIED",
  "default": true,
  "initializer": {}
}

Message that defines the compatible entity type.

Properties

Name	Type	Description
name	mix.api.ListEntitiesRequest.EntityType	Entity type name.
default	boolean	If set to true, specifies the default entity type for this data type.
initializer	object	Initializer.

mix.api.CoreDatapack

mix.api.CoreDatapack schema

{
  "isActive": true,
  "displayName": "string",
  "version": "string",
  "isDefault": true
}

Message that defines an ASR core data pack.

Properties

Name	Type	Description
isActive	boolean	When set to true, indicates that the locale/data pack is active.
displayName	string	Locale name.
version	string	Locale version.
isDefault	boolean	When set to true, indicates that the locale/data pack is the default one.

mix.api.CreateApplicationConfigResponse

mix.api.CreateApplicationConfigResponse schema

{
  "config": {
    "id": "2097",
    "tag": "billing_application",
    "deployments": [
      {
        "id": "38",
        "status": "PENDING_REQUEST",
        "envGeographyDeployments": []
      }
    ],
    "parentId": "null",
    "deploymentFlowId": 38,
    "createTime": "2021-04-21T19:45:44.809Z"
  }
}

Response object returned by the Create application configuration request.

Properties

Name	Type	Description
config	mix.api.ApplicationConfig	Application configuration.

mix.api.CreateEntityPayload

mix.api.CreateEntityPayload schema

{
  "listEntity": {
    "name": "BILL_PAID",
    "isDynamic": false,
    "settings": {
      "isSensitive": false,
      "canonicalize": true
    },
    "dataType": "YES_NO",
    "data": {
      "en-US": {
        "entries": [
          {
            "meaning": "yes",
            "patterns": [
              "yes"
            ]
          },
          {
            "meaning": "no",
            "patterns": [
              "no"
            ]
          }
        ]
      }
    }
  }
}

Message that defines the entity to create. Only one of relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be defined.

Properties

Name	Type	Description
relationalEntity	mix.api.RelationalEntityCreateRequest	Request object for creating a relational entity. At least one of isA or hasA must be specified.
listEntity	mix.api.ListEntityCreateRequest	Request object for creating a list entity.
freeformEntity	mix.api.FreeformEntityCreateRequest	Request object for creating a freeform entity.
regexEntity	mix.api.RegexEntityCreateRequest	Request object for creating a regex-based entity.
ruleBasedEntity	mix.api.RuleBasedEntityCreateRequest	Request object for creating a rule-based entity.

mix.api.CreateEntityResponse

mix.api.CreateEntityResponse schema

{
  "entity": {
    "listEntity": {
      "id": "deaacb09-80ad-4bb1-bf2d-352ec62e1e7c",
      "name": "COFFEE_TOPPINGS",
      "isDynamic": false,
      "numLiterals": 0,
      "settings": {
        "isSensitive": false,
        "canonicalize": true
      }
    }
  }
}

Response object returned by the Create entity request.

Properties

Name	Type	Description
entity	mix.api.EntityResponse	Response object for an entity. Only one of baseEntity, relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned.

mix.api.CreateIntentPayload

mix.api.CreateIntentPayload schema

{
  "intentName": "string"
}

Message that defines the intent to create.

Properties

Name	Type	Description
intentName	string	Intent name.

mix.api.CreateIntentResponse

mix.api.CreateIntentResponse schema

{
  "intent": {
    "id": "be567689-7948-45db-ae9a-8c18f5dc4634",
    "name": "PAY_COFFEE",
    "isInBaseOntology": false,
    "links": []
  }
}

Response object returned by the Create intent request.

Properties

Name	Type	Description
intent	mix.api.IntentResponse	Intent object.

mix.api.CreateProjectChannelResponse

mix.api.CreateProjectChannelResponse schema

{
  "channel": {
    "id": "33849b2a-24f5-493e-b156-d91799d5186d",
    "displayName": "Custom channel",
    "codeName": "custom",
    "modes": [
      "RICH_TEXT"
    ],
    "color": "INDIGO"
  },
  "isActive": true
}

Response object returned by the Create project channel request.

Properties

Name	Type	Description
channel	mix.api.Channel	Deprecated. Project channel.
isActive	boolean	When set to true, indicates that the channel is active.
extendedChannel	mix.api.ExtendedChannel	Message that defines a project channel.

mix.api.CreateProjectResponse

mix.api.CreateProjectResponse schema

{
  "project": {
    "id": "23977",
    "displayName": "Quick Start",
    "languageTopic": "gen",
    "channels": [
      {
        "channel": {
          "id": "34791",
          "displayName": "Text VA",
          "modes": [
            "RICH_TEXT"
          ],
          "color": "GREEN"
        },
        "isActive": true
      }
    ],
    "datapacks": [
      {
        "isActive": true,
        "displayName": "en-US",
        "version": "4.7.0",
        "isDefault": true
      },
      {
        "isActive": true,
        "displayName": "fr-CA",
        "version": "4.1.0",
        "isDefault": true
      }
    ],
    "baseDatapack": "9.4.1.19",
    "orgId": "2",
    "createTime": "2021-03-02T20:18:09.281Z",
    "updateTime": "2021-03-02T20:18:03Z"
  }
}

Response object returned by the Create project request.

Properties

Name	Type	Description
project	mix.api.Project	Message that defines a project.

mix.api.DataHost

mix.api.DataHost schema

{
  "id": "string",
  "alias": "string",
  "environmentId": "string",
  "environmentGeographyId": "string",
  "value": "string"
}

Data host object.

Properties

Name	Type	Description
id	string	ID of the data host.
alias	string	Alias of the data host.
environmentId	string	ID of the environment.
environmentGeographyId	string	ID of the environment geography.
value	string	Data host URL.

mix.api.DataPackUpdateRequest

mix.api.DataPackUpdateRequest schema

{
  "locale": "string",
  "version": "string"
}

Message that defines the locale and version to update.

Properties

Name	Type	Description
locale	string	Locale for which to update the Nuance data pack version; for example, en-US.
version	string	Version of the Nuance data pack to update to; for example, 4.7.0.

mix.api.DataType

mix.api.DataType schema

"NOT_SET"

ENUM that defines the available data types.

• NOT_SET: Nothing set.
• NO_FORMAT: No format.
• YES_NO: Literals mapped to the values “yes” and “no”.
• BOOLEAN: Literals mapped to the values “true” and “false”.
• NUMBER: Integers or decimal numbers.
• DIGITS: Numeric characters.
• DATE: The grammar must return a value with this format: YYYYMMDD.
• TIME: The grammar must return a value with this format: HHMM.
• ALPHANUM: Letters and numeric characters: A-Z, a-z, 0-9, or equivalent characters for the active language.
• AMOUNT: The grammar must return a JSON object literal with a number and a unit.
• DISTANCE: The grammar must return a JSON object literal with a number and a unit.
• TEMPERATURE: The grammar must return a JSON object literal with a number and a unit.

mix.api.DataTypes

mix.api.DataTypes schema

{
  "name": "NOT_SET",
  "schema": {},
  "compatibleEntityTypes": [
    {
      "name": "UNSPECIFIED",
      "default": true,
      "initializer": {}
    }
  ]
}

Message that defines the data types.

Properties

Name	Type	Description
name	mix.api.DataType	Data type name.
schema	object	Data type schema.
compatibleEntityTypes	[mix.api.CompatibleEntityType]	Entity types that support this data type.

mix.api.DeployApplicationConfigResponse

mix.api.DeployApplicationConfigResponse schema

{
  "deployments": [
    {
      "id": "1425",
      "configId": "2101",
      "approved": true,
      "comment": "",
      "promotionFlowStepId": "38",
      "code": 0,
      "createTime": "2021-04-22T18:37:38.806Z",
      "updateTime": "2021-04-22T18:37:38.806Z"
    }
  ]
}

Response object returned by the Deploy application configuration response.

Properties

Name	Type	Description
deployments	[mix.api.ApplicationConfigDeployment]	List of application configurations deployed.

mix.api.DeploymentFlow

mix.api.DeploymentFlow schema

{
  "id": "string",
  "displayName": "string",
  "steps": [
    {
      "id": "string",
      "step": 0,
      "requiresApproval": true,
      "environments": [
        {
          "id": "string",
          "displayName": "string",
          "geographies": [
            {}
          ]
        }
      ]
    }
  ]
}

Message that defines a deployment flow.

Properties

Name	Type	Description
id	string	Unique ID identifying the deployment flow in the organization.
displayName	string	Name of the deployment flow.
steps	[mix.api.DeploymentFlowStep]	List of steps in the flow.

mix.api.DeploymentFlowStatus

mix.api.DeploymentFlowStatus schema

"STATUS_UNSPECIFIED"

ENUM that defines the possible status of a deployment in the flow.

• DEPLOYED: Application configuration was deployed in the environment geography. The deployment may or may not have been successful. See deploymentResult for details.
• PENDING_APPROVAL: Deployment is pending approval
• PENDING_REQUEST: Application configuration was created but not deployed
• OVERRIDDEN: Deployment was overridden
• REJECTED: Request for deployment approval was rejected
• UNDEPLOYED: Application configuration has not yet been deployed in a preceding environment geography in this flow
• ACCEPTED: Request for approval was accepted. Deployment is in progress.

mix.api.DeploymentFlowStep

mix.api.DeploymentFlowStep schema

{
  "id": "string",
  "step": 0,
  "requiresApproval": true,
  "environments": [
    {
      "id": "string",
      "displayName": "string",
      "geographies": [
        {
          "id": "string",
          "geography": {
            "id": null,
            "displayName": null
          },
          "envType": "EST_TYPE_UNSPECIFIED",
          "envHost": "string",
          "envName": "string"
        }
      ]
    }
  ]
}

Message that defines a step within a deployment flow.

Properties

Name	Type	Description
id	string	Unique ID identifying the deployment flow step.
step	integer(int32)	Position of the step within the flow.
requiresApproval	boolean	When set to true, indicates that the deployment step requires approval.
environments	[mix.api.Environment]	List of environments for this step.

mix.api.DialogBody

mix.api.DialogBody schema

{
  "notes": "string"
}

Message that defines a dialog build.

Properties

Name	Type	Description
notes	string	Notes specified when starting the build.

mix.api.DialogBuildContent

mix.api.DialogBuildContent schema

{
  "projectId": "string",
  "buildVersion": "string",
  "buildLabel": "string",
  "createTime": "2019-08-24T14:15:22Z"
}

Message that defines a dialog build.

Properties

Name	Type	Description
projectId	string	ID of the project for the build.
buildVersion	string	Build version.
buildLabel	string	Build label.
createTime	string(date-time)	Date and time the build was created.

mix.api.DialogRequestModelContent

mix.api.DialogRequestModelContent schema

{
  "buildLabel": "string"
}

Message that defines a dialog request model content.

Properties

Name	Type	Description
buildLabel	string	Display name of the build.

mix.api.EnginePack

mix.api.EnginePack schema

{
  "enginePackId": "string",
  "version": "string",
  "dialogVersion": "string",
  "nluVersion": "string",
  "asrVersion": "string",
  "ttsVersion": "string",
  "isDefault": true,
  "topics": {
    "property1": {
      "locales": {
        "property1": {
          "versions": [
            {}
          ]
        },
        "property2": {
          "versions": [
            {}
          ]
        }
      }
    },
    "property2": {
      "locales": {
        "property1": {
          "versions": [
            {}
          ]
        },
        "property2": {
          "versions": [
            {}
          ]
        }
      }
    }
  }
}

Message that defines an engine pack.

Properties

Name	Type	Description
enginePackId	string	UUID of the engine pack.
version	string	Version of the engine pack as displayed in Mix.dashboard.
dialogVersion	string	Version of the Dialog engine supported by this engine pack.
nluVersion	string	Version of the NLU engine supported by this engine pack.
asrVersion	string	Version of the ASR engine supported by this engine pack.
ttsVersion	string	Version of the TTS engine supported by this engine pack.
isDefault	boolean	When set to true, indicates that this is the default engine pack version used when creating projects.
topics	[mix.api.EnginePack.Topic]	List of language topics supported in this engine pack version.

mix.api.EnginePack.DataPackVersion

mix.api.EnginePack.DataPackVersion schema

{
  "version": "string",
  "isSupported": true
}

Message that defines a data pack version.

Properties

Name	Type	Description
version	string	Data pack version.
isSupported	boolean	When set to true, indicates that the data pack version is supported.

mix.api.EnginePack.Locale

mix.api.EnginePack.Locale schema

{
  "versions": [
    {
      "version": "string",
      "isSupported": true
    }
  ]
}

Message that defines a locale for a language topic.

Properties

Name	Type	Description
versions	[mix.api.EnginePack.DataPackVersion]	The data pack versions available for this locale in this language topic. Ordered by decreasing semantic version number.

mix.api.EnginePack.Topic

mix.api.EnginePack.Topic schema

{
  "locales": {
    "property1": {
      "versions": [
        {
          "version": "string",
          "isSupported": true
        }
      ]
    },
    "property2": {
      "versions": [
        {
          "version": "string",
          "isSupported": true
        }
      ]
    }
  }
}

Message that defines a language topic.

Properties

Name	Type	Description
locales	[mix.api.EnginePack.Locale]	List of language topics supported in this engine pack version.

mix.api.EntityPayload

mix.api.EntityPayload schema

{
  "listEntity": {
    "settings": {
      "isSensitive": true
    }
  }
}

Message that defines the content to update in an entity. Only one of relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be defined.

Properties

Name	Type	Description
relationalEntity	mix.api.RelationalEntityUpdateRequest	Request object for updating a relational entity.
listEntity	mix.api.ListEntityUpdateRequest	Request object for updating a list entity.
freeformEntity	mix.api.FreeformEntityUpdateRequest	Request object for updating a freeform entity.
regexEntity	mix.api.RegexEntityUpdateRequest	Request object for updating a regex-based entity.
ruleBasedEntity	mix.api.RuleBasedEntityUpdateRequest	Request object for updating a rule-based entity.

mix.api.EntityResponse

Response object for an entity. Only one of baseEntity, relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned.

Properties

Name	Type	Description
baseEntity	mix.api.BaseEntity	Type for entities that are included by default with any NLU project. These are read-only.
relationalEntity	mix.api.RelationalEntity	Entity type that represents a relationship to one or more other entities.
listEntity	mix.api.ListEntity	Entity type used for recognizing a value from a list of finite literals.
freeformEntity	mix.api.FreeformEntity	Entity type used for recognizing any textual value. This is typically used for dictation.
regexEntity	mix.api.RegexEntity	Entity type used for pattern matching.
ruleBasedEntity	mix.api.RuleBasedEntity	Entity type used for recognizing a value based on a GrXML grammar file.

mix.api.EntitySettings

mix.api.EntitySettings schema

{
  "isSensitive": true,
  "canonicalize": true
}

Message that defines the settings for an entity.

Properties

Name	Type	Description
isSensitive	boolean	When set to true, indicates that the entity is sensitive.
canonicalize	boolean	When set to true, indicates that the entity is canonicalized.

mix.api.EntityTypes

mix.api.EntityTypes schema

{
  "name": "UNSPECIFIED",
  "description": "string",
  "initializer": {},
  "compatibleDataTypes": [
    "NOT_SET"
  ]
}

Message that defines the entity types.

Properties

Name	Type	Description
name	mix.api.ListEntitiesRequest.EntityType	Entity type name.
description	string	Entity type description.
initializer	object	Initializer.
compatibleDataTypes	[mix.api.DataType]	Data types supported by this entity type.

mix.api.Environment

mix.api.Environment schema

{
  "id": "string",
  "displayName": "string",
  "geographies": [
    {
      "id": "string",
      "geography": {
        "id": "string",
        "displayName": "string"
      },
      "envType": "EST_TYPE_UNSPECIFIED",
      "envHost": "string",
      "envName": "string"
    }
  ]
}

Message that defines an environment.

Properties

Name	Type	Description
id	string	Unique ID identifying the environment in the organization.
displayName	string	Name of the environment.
geographies	[mix.api.EnvironmentGeography]	List of environment geographies.

mix.api.EnvironmentGeography

mix.api.EnvironmentGeography schema

{
  "id": "string",
  "geography": {
    "id": "string",
    "displayName": "string"
  },
  "envType": "EST_TYPE_UNSPECIFIED",
  "envHost": "string",
  "envName": "string"
}

Message that defines an environment geography.

Properties

Name	Type	Description
id	string	Unique ID identifying the environment geography.
geography	mix.api.Geography	Object defining the Nuance geography.
envType	mix.api.EnvironmentType	Type of environment.
envHost	string	Host of environment.
envName	string	Environment name.

mix.api.EnvironmentGeographyAppConfigDeployment

mix.api.EnvironmentGeographyAppConfigDeployment schema

{
  "id": "string",
  "envGeography": {
    "id": "string",
    "geography": {
      "id": "string",
      "displayName": "string"
    },
    "envType": "EST_TYPE_UNSPECIFIED",
    "envHost": "string",
    "envName": "string"
  },
  "status": "STATUS_UNSPECIFIED",
  "deploymentResult": "string",
  "isOverridden": true,
  "requestedBy": {
    "id": "string",
    "email": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "lastLoginTime": "2019-08-24T14:15:22Z",
    "name": "string"
  },
  "approvedBy": {
    "id": "string",
    "email": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "lastLoginTime": "2019-08-24T14:15:22Z",
    "name": "string"
  },
  "dataHosts": [
    {
      "id": "string",
      "alias_id": "string",
      "alias": "string",
      "value": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "approvedAt": "2019-08-24T14:15:22Z",
  "approvalRequired": true
}

Message that defines the list of environment geographies where the application configuration was deployed.

Properties

Name	Type	Description
id	string	Unique ID identifying the deployment flow for an application configuration.
envGeography	mix.api.EnvironmentGeography	Environment geography where the application configuration was deployed.
status	mix.api.DeploymentFlowStatus	Indicates the status of the deployment in the flow (DEPLOYED, PENDING_REQUEST, and so on).
deploymentResult	string	Indicates the result of the deployment operation (success, stuck, and so on).
isOverridden	boolean	Boolean indicating whether this deployed application configuration was overridden.
requestedBy	mix.api.User	User that requested this deployment.
approvedBy	mix.api.User	User that approved this deployment (if approval was required).
dataHosts	[mix.api.EnvironmentGeography AppConfigDeployment. AppConfigDataHost]	List of data hosts assigned to this application configuration.
createdAt	string(date-time)	Date and time the deployment to this environment-geography was created.
approvedAt	string(date-time)	Date and time the deployment to this environment-geography was approved (if approval was required).
approvalRequired	boolean	When set to true, indicates that this environment-geography requires approval to deploy to it.

mix.api.EnvironmentGeographyAppConfigDeployment. AppConfigDataHost

mix.api.EnvironmentGeographyAppConfigDeployment.AppConfigDataHost schema

{
  "id": "string",
  "alias_id": "string",
  "alias": "string",
  "value": "string"
}

Properties

Name	Type	Description
id	string	ID of the AppConfig data host.
alias_id	string	ID of the alias.
alias	string	Alias of the data host.
value	string	Value of the AppConfig data host.

mix.api.EnvironmentType

mix.api.EnvironmentType schema

"EST_TYPE_UNSPECIFIED"

ENUM that defines the type of environment.

• EST_TYPE_UNSPECIFIED: Unspecified type
• SANDBOX: Sandbox environment
• PRODUCTION: Production environment

mix.api.Error

mix.api.Error schema

{
  "message": "string",
  "code": "string"
}

Message that defines an error.

Properties

Name	Type	Description
message	string	Error message, if applicable.
code	string	Error code, if applicable.

mix.api.Errors

mix.api.Errors schema

{
  "errors": [
    {
      "message": "string",
      "code": "string"
    }
  ]
}

Message that defines errors.

Properties

Name	Type	Description
errors	[mix.api.Error]	List of build errors, if applicable.

mix.api.ExtendedChannel

mix.api.ExtendedChannel schema

{
  "id": "string",
  "displayName": "string",
  "codeName": "string",
  "modes": [
    {
      "mode": "MODE_UNSPECIFIED",
      "isActive": true
    }
  ],
  "color": "COLOR_UNSPECIFIED"
}

Message that defines an ExtendedChannel object, which provides an extended set of attributes about the channels available in a project.

Properties

Name	Type	Description
id	string	UUID of the channel.
displayName	string	Name of the channel.
codeName	string	Code name of the channel to use when invoking DLGaaS.
modes	[mix.api.ExtendedModality]	List of modalities available for messages in this channel.
color	mix.api.ChannelColor	Color of the channel.

mix.api.ExtendedChannelTarget

mix.api.ExtendedChannelTarget schema

{
  "channel": {
    "id": "string",
    "displayName": "string",
    "codeName": "string",
    "modes": [
      {
        "mode": "MODE_UNSPECIFIED",
        "isActive": true
      }
    ],
    "color": "COLOR_UNSPECIFIED"
  },
  "isActive": true
}

Message that defines an ExtendedChannelTarget object, which provides an extended set of attributes about the channel targets available in a project.

Properties

Name	Type	Description
channel	mix.api.ExtendedChannel	Project channel.
isActive	boolean	When set to true, indicates that the channel is active.

mix.api.ExtendedModality

mix.api.ExtendedModality schema

{
  "mode": "MODE_UNSPECIFIED",
  "isActive": true
}

Message that defines an ExtendedModality object, which provides an extended set of attributes about the modalities available in a project.

Properties

Name	Type	Description
mode	mix.api.Modality	Modality name.
isActive	boolean	When set to true, indicates that the modality is active.

mix.api.ExtendedProject

mix.api.ExtendedProject schema

{
  "id": "string",
  "displayName": "string",
  "languageTopic": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "channels": [
    {
      "channel": {
        "id": "string",
        "displayName": "string",
        "codeName": "string",
        "modes": [
          "MODE_UNSPECIFIED"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      "isActive": true
    }
  ],
  "datapacks": [
    {
      "isActive": true,
      "displayName": "string",
      "version": "string",
      "isDefault": true
    }
  ],
  "baseDatapack": "string",
  "enginePackId": "string",
  "isFavorite": true,
  "orgId": "string",
  "lastSavedTime": "2019-08-24T14:15:22Z",
  "lastUsedTime": "2019-08-24T14:15:22Z",
  "lock": {
    "lockId": "18",
    "projectId": "2960",
    "lockOwner": {
      "id": "36",
      "email": "alex.smith@company.com"
    },
    "notes": "Exporting model",
    "createTime": "2021-11-10T15:33:35Z"
  },
  "orgDisplayName": "string",
  "lastAsrModelCreateTime": "2019-08-24T14:15:22Z",
  "lastNluModelCreateTime": "2019-08-24T14:15:22Z",
  "lastDialogModelCreateTime": "2019-08-24T14:15:22Z",
  "policy": {
    "isAccepted": true,
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "projectDescription": "string"
  },
  "extendedChannels": [
    {
      "channel": {
        "id": "string",
        "displayName": "string",
        "codeName": "string",
        "modes": [
          {
            "mode": null,
            "isActive": null
          }
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      "isActive": true
    }
  ],
  "enginePackFeatures": [
    "string"
  ]
}

Message that defines an ExtendedProject object.

Properties

Name	Type	Description
id	string	Unique ID identifying the project.
displayName	string	Project name.
languageTopic	string	Project language topic.
createTime	string(date-time)	Date and time the project was created.
updateTime	string(date-time)	Date and time the project was last updated.
channels	[mix.api.ChannelTarget]	Deprecated. List of channels available in this project.
datapacks	[mix.api.CoreDatapack]	List of core data packs available in this project.
baseDatapack	string	QuickNLP data pack used in this project.
enginePackId	string	The ID of the engine pack associated with this project, if defined.
isFavorite	boolean	When set to true, indicates the project is in the user's Favorites list.
orgId	string	ID identifying the organization for this project.
lastSavedTime	string(date-time)	Date and time the project was last saved.
lastUsedTime	string(date-time)	Date and time the project was last used.
lock	mix.api.ProjectLock	Project lock instance, if available.
orgDisplayName	string	Name identifying the organization for this project.
lastAsrModelCreateTime	string(date-time)	Date and time the last ASR model was created.
lastNluModelCreateTime	string(date-time)	Date and time the last NLU model was created.
lastDialogModelCreateTime	string(date-time)	Date and time the last Dialog model was created.
policy	mix.api.ChildDataCompliant	Child data compliancy policy.
extendedChannels	[mix.api.ExtendedChannelTarget]	List of ExtendedChannelTarget objects, which provide an extended set of attributes about the channel targets available in this project.
enginePackFeatures	[string]	List of features supported by this project's engine pack.

mix.api.FreeformEntity

mix.api.FreeformEntity schema

{
  "id": "string",
  "name": "string",
  "dataSource": "string",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Entity type used for recognizing any textual value. This is typically used for dictation.

Properties

Name	Type	Description
id	string	UUID of the entity.
name	string	Entity name.
dataSource	string	Data source used for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.FreeformEntityCreateRequest

mix.api.FreeformEntityCreateRequest schema

{
  "name": "string",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Request object for creating a freeform entity.

Properties

Name	Type	Description
name	string	Entity name.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.FreeformEntityUpdateRequest

mix.api.FreeformEntityUpdateRequest schema

{
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Request object for updating a freeform entity.

Properties

Name	Type	Description
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.GenericBuildReport

mix.api.GenericBuildReport schema

{
  "locale": "string",
  "version": "string",
  "errors": {
    "errors": [
      {
        "message": "string",
        "code": "string"
      }
    ]
  },
  "buildLabel": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "status": "string"
}

Message that defines a build report.

Properties

Name	Type	Description
locale	string	Locale used for the build, if applicable.
version	string	Build model version, if applicable.
errors	mix.api.Errors	Job errors, if applicable.
buildLabel	string	Build label, if applicable.
createTime	string(date-time)	Date and time the report was created.
status	string	Status of the task.

mix.api.GenericBuildReports

mix.api.GenericBuildReports schema

{
  "reports": [
    {
      "locale": "string",
      "version": "string",
      "errors": {
        "errors": [
          {
            "message": null,
            "code": null
          }
        ]
      },
      "buildLabel": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "status": "string"
    }
  ]
}

Message that defines a list of build reports.

Properties

Name	Type	Description
reports	[mix.api.GenericBuildReport]	List of build reports.

mix.api.GenericProjectReport

mix.api.GenericProjectReport schema

{
  "locale": "string",
  "errors": {
    "errors": [
      {
        "message": "string",
        "code": "string"
      }
    ]
  },
  "status": "RUNNING",
  "intent": "string",
  "entity": "string",
  "createTime": "2019-08-24T14:15:22Z"
}

Message that defines a project report.

Properties

Name	Type	Description
locale	string	Project locale, if applicable.
errors	mix.api.Errors	Job errors, if applicable.
status	mix.api.JobStatusType	Status of the job.
intent	string	Target intent, if applicable.
entity	string	Target entity, if applicable.
createTime	string(date-time)	Date and time the report was created.

mix.api.GenericProjectReports

mix.api.GenericProjectReports schema

{
  "reports": [
    {
      "locale": "string",
      "errors": {
        "errors": [
          {
            "message": null,
            "code": null
          }
        ]
      },
      "status": "RUNNING",
      "intent": "string",
      "entity": "string",
      "createTime": "2019-08-24T14:15:22Z"
    }
  ]
}

Message that defines a list of project related reports.

Properties

Name	Type	Description
reports	[mix.api.GenericProjectReport]	List of project reports.

mix.api.Geography

mix.api.Geography schema

{
  "id": "string",
  "displayName": "string"
}

Message that defines a Nuance geography.

Properties

Name	Type	Description
id	string	Unique ID identifying the Nuance geography.
displayName	string	Name of the Nuance geography (for example, US, Canada).

mix.api.GetApplicationConfigResponse

mix.api.GetApplicationConfigResponse schema

{
  "config": {
    "id": "670",
    "tag": "A35_C670",
    "deployments": [
      {
        "id": "38",
        "status": "DEPLOYED",
        "envGeographyDeployments": [
          {
            "id": "645",
            "envGeography": {
              "id": "37",
              "geography": {
                "id": "1",
                "displayName": "US"
              },
              "envType": "SANDBOX",
              "envHost": "api.nuance.co.uk",
              "envName": "Sandbox"
            },
            "status": "DEPLOYED",
            "deploymentResult": "success",
            "isOverridden": false,
            "dataHosts": []
          }
        ]
      }
    ],
    "parentId": "",
    "deploymentFlowId": 38,
    "builds": {
      "asr": {
        "builds": [
          {
            "locale": "en-US",
            "buildVersion": "2",
            "buildLabel": "ASR_17100_2",
            "createTime": "2020-07-16T20:40:25Z"
          },
          {
            "locale": "fr-FR",
            "buildVersion": "1",
            "buildLabel": "ASR_17100_1",
            "createTime": "2020-07-16T20:40:15Z"
          }
        ],
        "projectId": "17100"
      },
      "nlu": {
        "builds": [
          {
            "locale": "en-US",
            "buildVersion": "2",
            "buildLabel": "NLU_17100_2",
            "createTime": "2020-07-16T20:40:20Z"
          },
          {
            "locale": "fr-FR",
            "buildVersion": "1",
            "buildLabel": "NLU_17100_1",
            "createTime": "2020-07-16T20:40:11Z"
          }
        ],
        "projectId": "17100"
      }
    },
    "projectDetails": {
      "projectId": "17100",
      "projectName": "CoffeeApp MultiLang",
      "isChildDataCompliant": true,
      "projectDescription": ""
    },
    "createTime": "2020-07-20T18:38:22Z"
  }
}

Response object returned by the Get application configuration request.

Properties

Name	Type	Description
config	mix.api.ApplicationConfig	Application configuration.

mix.api.GetBotConfigInterfaceResponse

mix.api.GetBotConfigInterfaceResponse schema

{
  "interface": {
    "id": "1159",
    "version": 7,
    "languageTopic": "gen",
    "locales": [
      "en-US"
    ],
    "channels": [
      {
        "id": "8e432bd2-6512-4da3-8236-66a6f94b6e44",
        "displayName": "Audio VA",
        "codeName": "Audio VA",
        "modes": [
          "TTS"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "88544ae0-9fe1-4a3b-b7eb-129614c3532a",
        "displayName": "Text VA",
        "codeName": "Text VA",
        "modes": [
          "RICH_TEXT"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "bd47faf3-ec97-4f63-ac8d-53f7822c2d24",
        "displayName": "IVR/Voice VA",
        "codeName": "IVR/Voice VA",
        "modes": [
          "AUDIO_SCRIPT"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "42dcfbf7-86b2-46f8-b495-0d3bf7907248",
        "displayName": "Digital VA",
        "codeName": "Digital VA",
        "modes": [
          "INTERACTIVITY",
          "RICH_TEXT",
          "TTS"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "454bea86-0e77-49b4-b527-0188d46a52c2",
        "displayName": "Omni Channel VA",
        "codeName": "Omni Channel VA",
        "modes": [
          "AUDIO_SCRIPT",
          "INTERACTIVITY",
          "RICH_TEXT",
          "TTS"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      {
        "id": "23371c6d-2760-4aed-af6e-13c75d86f3a6",
        "displayName": "Default",
        "codeName": "default",
        "modes": [
          "TTS",
          "AUDIO_SCRIPT",
          "RICH_TEXT",
          "INTERACTIVITY"
        ],
        "color": "COLOR_UNSPECIFIED"
      }
    ],
    "variables": [
      {
        "id": "f1718da9-1653-4f5e-a0c1-3d1f581231d6",
        "displayName": "accountList",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "LIST_TYPE",
        "complexGenericTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
      },
      {
        "id": "a49808bf-4f4f-4e38-bb35-7e173547cb06",
        "displayName": "language",
        "description": "The current language; initially set to the default language of the project",
        "isReserved": true,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "d2dc5ba3-98da-4292-8fe7-a619682d725a",
        "displayName": "intentValue",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "5cf039f0-c109-4243-971a-3f46f501f999",
        "displayName": "date",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "DATE_TYPE"
      },
      {
        "id": "34e222aa-5489-4870-934a-a7d7460110ca",
        "displayName": "returnMessage",
        "description": "The return message variable that describes the meaning of the returnCode variable",
        "isReserved": true,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "dcb0e74f-1bd2-4f1f-a342-e3ccee4e5fad",
        "displayName": "timezone",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "f864ab5e-e951-402e-a9fb-c9f905e1d13a",
        "displayName": "myAccount",
        "description": "",
        "isReserved": false,
        "complexVariableTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
      },
      {
        "id": "3cc3578f-7f41-4761-a15e-19e621d6b681",
        "displayName": "userData",
        "description": "The data collected from the end user.",
        "isReserved": true,
        "complexVariableTypeId": "c4ea5e93-fca4-40a8-99c9-bb442f6ec0cc"
      },
      {
        "id": "e4f2b89b-9551-4ebb-8d6d-2e513d814d35",
        "displayName": "lastConfirmationResultObject",
        "description": "",
        "isReserved": true,
        "complexVariableTypeId": "21f00d74-95f7-4cbf-a20e-ea877ea72de1"
      },
      {
        "id": "9cf698cd-445e-4dac-9fa7-620db10b654b",
        "displayName": "channelIntegration",
        "description": "The channel integration on the client-side.",
        "isReserved": true,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "11ad45b4-f7ac-4b2e-832e-f32f6ad51da3",
        "displayName": "randomInt",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "INTEGER_TYPE"
      },
      {
        "id": "9422d27d-5b61-4e05-8701-c4cbf8352219",
        "displayName": "payeeWordset",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "DYNAMIC_ENTITY_DATA"
      },
      {
        "id": "2d0e7d7f-04b1-4403-9f07-9944df0a929f",
        "displayName": "accountTypeWordset",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "DYNAMIC_ENTITY_DATA"
      },
      {
        "id": "fb8a0614-1f3f-428c-97f5-e3d241723f5d",
        "displayName": "nulString",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "47bce83f-9d4a-4a79-a6b4-c36d605b59a4",
        "displayName": "myMessageVar",
        "description": "",
        "isReserved": false,
        "complexVariableTypeId": "a5133103-dfe2-4432-83ba-0a057ecbc05d"
      },
      {
        "id": "d7ce400f-dc6f-4e7d-80e5-f0744b8a776e",
        "displayName": "temp",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "AMOUNT_TYPE"
      },
      {
        "id": "51b23544-6986-418b-beda-14486fd37656",
        "displayName": "intentLiteral",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "b2112948-d648-4f90-a3ef-02457b1776c4",
        "displayName": "returnCode",
        "description": "The return code variable for data access nodes",
        "isReserved": true,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "b519fa46-c4bc-431d-b4c6-e846445c4af6",
        "displayName": "confidenceScore",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      },
      {
        "id": "86b14181-5dcf-449a-b1b9-03f43a22bd80",
        "displayName": "lastCollectionResultObject",
        "description": "",
        "isReserved": true,
        "complexVariableTypeId": "21f00d74-95f7-4cbf-a20e-ea877ea72de1"
      },
      {
        "id": "7f24bf8d-519f-4f47-9a31-e594b6d5d0be",
        "displayName": "user",
        "description": "",
        "isReserved": false,
        "complexVariableTypeId": "d6c03136-1c81-47ec-a0c4-e1d04415e3aa"
      },
      {
        "id": "afaa4ea6-ecd8-42a6-bc30-cc5ded710cc0",
        "displayName": "previousIntent",
        "description": "",
        "isReserved": false,
        "simpleVariableType": "STRING_TYPE"
      }
    ],
    "transferNodes": [
      {
        "id": "5414ad73-0da7-47ae-9f4a-d870cc8f4e27",
        "nodeName": "MainEnd",
        "nodeType": "END",
        "description": "",
        "requestVariables": []
      },
      {
        "id": "86880327-8fa6-4aba-b3d3-f9317215956f",
        "nodeName": "EscalateAction",
        "nodeType": "ESCALATE",
        "description": "",
        "requestVariables": [
          {
            "id": "f864ab5e-e951-402e-a9fb-c9f905e1d13a",
            "displayName": "myAccount",
            "description": "",
            "isReserved": false,
            "complexVariableTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
          },
          {
            "id": "7f24bf8d-519f-4f47-9a31-e594b6d5d0be",
            "displayName": "user",
            "description": "",
            "isReserved": false,
            "complexVariableTypeId": "d6c03136-1c81-47ec-a0c4-e1d04415e3aa"
          },
          {
            "id": "51b23544-6986-418b-beda-14486fd37656",
            "displayName": "intentLiteral",
            "description": "",
            "isReserved": false,
            "simpleVariableType": "STRING_TYPE"
          }
        ]
      }
    ],
    "createTime": "2021-01-28T01:19:03.468Z"
  }
}

Response object returned by the Get Bot Config Interface request.

Properties

Name	Type	Description
interface	mix.api.BotConfigInterface	Interface for the bot and application configuration specified.

mix.api.GetBuildResponse

mix.api.GetBuildResponse schema

{
  "projectId": "11624",
  "buildLabel": "NLU_11624_1",
  "buildId": "463",
  "buildType": "NLU",
  "buildVersion": "1",
  "status": "BST_COMPLETED",
  "languageTopic": "gen",
  "datapack": {
    "displayName": "en-US",
    "version": "4.5.0"
  },
  "notes": "",
  "createTime": "2020-05-06T19:02:09.262Z",
  "modelType": "LEGACY"
}

Response object returned by the Get build details request.

Properties

Name	Type	Description
projectId	string	ID of the project.
buildLabel	string	Display name of the build.
buildId	string	ID of the build.
buildType	mix.api.BuildType	Type of build.
buildVersion	string	Model version.
status	mix.api.BuildStatusType	Build status of the model.
errors	mix.api.Errors	Build errors, if applicable.
createTime	string(date-time)	Date and time the model was created.
languageTopic	string	Language topic of the model, if applicable.
datapack	mix.api.CoreDatapack	Data pack used in the model, if applicable.
dynamicEntities	[object]	Dynamic entities in the model, if applicable.
notes	string	Model notes.
modelType	mix.api.NLUModelType	NLU Model type, if applicable.
dataSources	[object]	Data sources in the model, if applicable.
parentNLUBuildLabel	string	Parent NLU Build id, if applicable.

mix.api.GetEntityResponse

mix.api.GetEntityResponse schema

{
  "entity": {
    "listEntity": {
      "id": "73cb7c26-fed5-4331-8701-6736d98c40d6",
      "name": "COFFEE_TYPE",
      "isDynamic": false,
      "numLiterals": 9,
      "settings": {
        "isSensitive": false,
        "canonicalize": true
      },
      "dataType": "NO_FORMAT"
    }
  }
}

Response object returned by the Get entity details request.

Properties

Name	Type	Description
entity	mix.api.EntityResponse	Response object for an entity. Only one of baseEntity, relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned.

mix.api.GetIntentResponse

mix.api.GetIntentResponse schema

{
  "intent": {
    "id": "a9e7428a-5c12-4ead-9aad-c6b7d8723ee7",
    "name": "ORDER_COFFEE",
    "isInBaseOntology": false,
    "links": [
      {
        "entityRef": "COFFEE_SIZE"
      },
      {
        "entityRef": "COFFEE_TYPE"
      }
    ]
  }
}

Response object for Get intent details request.

Properties

Name	Type	Description
intent	mix.api.IntentResponse	Details of the intent.

mix.api.GetProjectLockResponse

mix.api.GetProjectLockResponse schema

{
  "lock": {
    "lockId": "18",
    "projectId": "2960",
    "lockOwner": {
      "id": "36",
      "email": "alex.smith@company.com"
    },
    "notes": "Exporting model",
    "createTime": "2021-11-10T15:33:35Z"
  }
}

Response object returned by the Get project lock request.

Properties

Name	Type	Description
lock	mix.api.ProjectLock	Project lock instance, if available.

mix.api.GetProjectResponse

mix.api.GetProjectResponse schema

{
  "project": {
    "id": "23079",
    "displayName": "GA Bank Demo",
    "languageTopic": "gen",
    "channels": [
      {
        "channel": {
          "id": "33424",
          "displayName": "Omni Channel VA",
          "codeName": "Omni Channel VA",
          "modes": [
            "AUDIO_SCRIPT",
            "DTMF",
            "INTERACTIVITY",
            "RICH_TEXT",
            "TTS"
          ],
          "color": "PURPLE"
        },
        "isActive": true
      },
      {
        "channel": {
          "id": "33425",
          "displayName": "IVR/Voice VA",
          "codeName": "IVR/Voice VA",
          "modes": [
            "AUDIO_SCRIPT",
            "DTMF"
          ],
          "color": "LIGHT_ORANGE"
        },
        "isActive": true
      },
      {
        "channel": {
          "id": "33426",
          "displayName": "Digital VA",
          "codeName": "Digital VA",
          "modes": [
            "INTERACTIVITY",
            "RICH_TEXT",
            "TTS"
          ],
          "color": "GREEN"
        },
        "isActive": true
      },
      {
        "channel": {
          "id": "33427",
          "displayName": "Text VA",
          "codeName": "Text VA",
          "modes": [
            "RICH_TEXT"
          ],
          "color": "CORN_FLOWER"
        },
        "isActive": true
      },
      {
        "channel": {
          "id": "33428",
          "displayName": "Audio VA",
          "codeName": "Audio VA",
          "modes": [
            "TTS"
          ],
          "color": "PINK"
        },
        "isActive": true
      }
    ],
    "datapacks": [
      {
        "displayName": "fr-FR",
        "version": "4.1.0",
        "isActive": true,
        "isDefault": true
      },
      {
        "displayName": "en-US",
        "version": "4.7.0",
        "isActive": true,
        "isDefault": true
      }
    ],
    "baseDatapack": "9.4.1.25",
    "orgId": "2",
    "createTime": "2021-01-18T16:44:58.947Z",
    "updateTime": "2021-01-18T16:45:56Z"
  }
}

Response object returned by the Get project details request.

Properties

Name	Type	Description
project	mix.api.Project	Details of the project.

mix.api.HasA

mix.api.HasA schema

{
  "entities": [
    "string"
  ]
}

Message that defines a HasA object.

Properties

Name	Type	Description
entities	[string]	Names of the entities that this entity has a hasA relationship with. Set entities to empty (that is, to []) in order to clear the values when using the Update an entity request.

mix.api.IntentResponse

mix.api.IntentResponse schema

{
  "id": "a9e7428a-5c12-4ead-9aad-c6b7d8723ee7",
  "name": "ORDER_COFFEE",
  "isInBaseOntology": false,
  "links": [
    {
      "entityRef": "COFFEE_SIZE"
    },
    {
      "entityRef": "COFFEE_TYPE"
    }
  ]
}

Message that defines an intent.

Properties

Name	Type	Description
id	string	Unique ID identifying the intent.
name	string	Intent name.
isInBaseOntology	boolean	When set to true, indicates that this intent is in the base ontology.
links	[mix.api.Link]	List of entities linked to this intent.
dataSource	string	Data source used for this intent, if applicable.

mix.api.JobReport

mix.api.JobReport schema

{
  "nluBuildReports": {
    "reports": [
      {
        "locale": "string",
        "version": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "buildLabel": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "status": "string"
      }
    ]
  },
  "asrBuildReports": {
    "reports": [
      {
        "locale": "string",
        "version": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "buildLabel": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "status": "string"
      }
    ]
  },
  "dialogBuildReports": {
    "reports": [
      {
        "locale": "string",
        "version": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "buildLabel": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "status": "string"
      }
    ]
  },
  "replaceProjectDialogReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "replaceProjectContentReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "replaceProjectPronunciationsReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "replaceProjectTransformationsReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "resetProjectReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "appendProjectOntologyReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "addProjectIntentSamplesReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "removeProjectIntentSamplesReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "addEntityLiteralsReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "removeEntityLiteralsReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "replaceProjectMetadataReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "updateDatapackReports": {
    "reports": [
      {
        "locale": "string",
        "errors": {
          "errors": [
            null
          ]
        },
        "status": "RUNNING",
        "intent": "string",
        "entity": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ]
  }
}

Message that defines a job report.

Properties

Name	Type	Description
nluBuildReports	mix.api.GenericBuildReports	NLU job reports, if applicable.
asrBuildReports	mix.api.GenericBuildReports	ASR job reports, if applicable.
dialogBuildReports	mix.api.GenericBuildReports	Dialog job reports, if applicable.
replaceProjectDialogReports	mix.api.GenericProjectReports	Replace project dialog job reports, if applicable.
replaceProjectContentReports	mix.api.GenericProjectReports	Replace project content job reports, if applicable.
replaceProjectPronunciationsReports	mix.api.GenericProjectReports	Replace project pronunciations job reports, if applicable.
replaceProjectTransformationsReports	mix.api.GenericProjectReports	Replace project transformations job reports, if applicable.
resetProjectReports	mix.api.GenericProjectReports	Reset project job reports, if applicable.
appendProjectOntologyReports	mix.api.GenericProjectReports	Append project ontology job reports, if applicable.
addProjectIntentSamplesReports	mix.api.GenericProjectReports	Add project intent samples job reports, if applicable.
removeProjectIntentSamplesReports	mix.api.GenericProjectReports	Remove project intent samples job reports, if applicable.
addEntityLiteralsReports	mix.api.GenericProjectReports	Add entity literals job reports, if applicable.
removeEntityLiteralsReports	mix.api.GenericProjectReports	Remove entity literals task reports, if applicable.
replaceProjectMetadataReports	mix.api.GenericProjectReports	Replace project metadata reports, if applicable.(Limited to project channels).
updateDatapackReports	mix.api.GenericProjectReports	Update NLU data pack reports, if applicable.

mix.api.JobResponse

mix.api.JobResponse schema

{
  "id": "430a4626-3b41-4fa2-bb8b-db1c7c2c7189",
  "type": "APPEND_INTENT_SAMPLES",
  "projectId": "2960",
  "status": "COMPLETED",
  "report": {
    "addProjectIntentSamplesReports": {
      "reports": [
        {
          "status": "COMPLETED",
          "locale": "en-US",
          "createTime": "2021-06-08T21:10:38.076Z"
        }
      ]
    }
  },
  "createTime": "2021-06-08T21:10:37.456Z",
  "updateTime": "2021-06-08T21:10:52.052Z",
  "duration": "14.596s"
}

Response object returned by the Get job details request.

Properties

Name	Type	Description
id	string	ID of the job.
type	mix.api.JobType	Type of the job.
projectId	string	ID of the project for which the job was created.
status	mix.api.JobStatusType	Status of the job.
report	mix.api.JobReport	Job report, if applicable.
createTime	string(date-time)	Date and time the job was created.
updateTime	string(date-time)	Date and time the job was last updated.
duration	string	Duration for the current job state.

mix.api.JobStatusType

mix.api.JobStatusType schema

"RUNNING"

ENUM that defines the status of a job.

• RUNNING: Job is currently running
• COMPLETED: Job has completed
• PARTIALLY_COMPLETED: Job has partially completed; for example, a build operation failed
• FAILED: Job has failed
• CANCELED: Job was cancelled
• TIMED_OUT: Job has timed out; this occurs when a job fails to complete in 6 hours
• STARTED: Job has started

mix.api.JobType

mix.api.JobType schema

"BUILD_MODELS"

ENUM that defines the type of job.

• BUILD_MODELS: Build ASR, NLU, and dialog models
• REPLACE_PROJECT: Replace project
• APPEND_ONTOLOGY: Append ontology
• APPEND_INTENT_SAMPLES: Append samples to intent
• REPLACE_INTENT_SAMPLES: Replace intent samples
• APPEND_ENTITY_LITERALS: Append entity literals
• REPLACE_ENTITY_LITERALS: Replace entity literals
• UPDATE_DATAPACK: Update data pack

mix.api.LanguageTopic

mix.api.LanguageTopic schema

{
  "id": "string",
  "name": "string",
  "locales": [
    {
      "locale": "string",
      "language": "string",
      "country": "string",
      "displayLanguage": "string",
      "displayCountry": "string",
      "versions": [
        "string"
      ]
    }
  ]
}

Message that defines a language topic.

Properties

Name	Type	Description
id	string	Unique ID identifying the language topic.
name	string	Name of the language topic.
locales	[mix.api.LanguageTopicLocale]	List of locales for a language topic.

mix.api.LanguageTopicLocale

mix.api.LanguageTopicLocale schema

{
  "locale": "string",
  "language": "string",
  "country": "string",
  "displayLanguage": "string",
  "displayCountry": "string",
  "versions": [
    "string"
  ]
}

Message that defines a locale for a language topic.

Properties

Name	Type	Description
locale	string	Code of the locale.
language	string	Language code of this locale.
country	string	Country code of this locale.
displayLanguage	string	Display name of the language.
displayCountry	string	Display name of the country.
versions	[string]	The data pack versions available for this locale in this language topic. Ordered by decreasing semantic version number.

mix.api.Link

mix.api.Link schema

{
  "entityRef": "string"
}

Message that defines an entity linked to an intent.

Properties

Name	Type	Description
entityRef	string	Name of the linked entity.

mix.api.ListApplicationConfigsResponse

mix.api.ListApplicationConfigsResponse schema

{
  "configs": [
    {
      "id": "670",
      "tag": "A35_C670",
      "deployments": [
        {
          "id": "38",
          "status": "DEPLOYED",
          "envGeographyDeployments": [
            {
              "id": "645",
              "envGeography": {
                "id": "37",
                "geography": {
                  "id": "1",
                  "displayName": "US"
                },
                "envType": "SANDBOX",
                "envHost": "api.nuance.co.uk",
                "envName": "Sandbox"
              },
              "status": "DEPLOYED",
              "deploymentResult": "success",
              "isOverridden": false,
              "dataHosts": []
            }
          ]
        }
      ],
      "parentId": "",
      "deploymentFlowId": 38,
      "builds": {
        "asr": {
          "builds": [
            {
              "locale": "fr-FR",
              "buildVersion": "1",
              "buildLabel": "ASR_17100_1",
              "createTime": "2020-07-16T20:40:15Z"
            },
            {
              "locale": "en-US",
              "buildVersion": "2",
              "buildLabel": "ASR_17100_2",
              "createTime": "2020-07-16T20:40:25Z"
            }
          ],
          "projectId": "17100"
        },
        "nlu": {
          "builds": [
            {
              "locale": "fr-FR",
              "buildVersion": "1",
              "buildLabel": "NLU_17100_1",
              "createTime": "2020-07-16T20:40:11Z"
            },
            {
              "locale": "en-US",
              "buildVersion": "2",
              "buildLabel": "NLU_17100_2",
              "createTime": "2020-07-16T20:40:20Z"
            }
          ],
          "projectId": "17100"
        }
      },
      "projectDetails": {
        "projectId": "17100",
        "projectName": "CoffeeApp MultiLang",
        "isChildDataCompliant": true,
        "projectDescription": ""
      },
      "createTime": "2020-07-20T18:38:22Z"
    }
  ],
  "totalSize": 1
}

Response object returned by the Get list of application configurations request.

Properties

Name	Type	Description
configs	[mix.api.ApplicationConfig]	List of application configurations.
totalSize	integer(int32)	Total number of application configurations that match the request.

mix.api.ListApplicationCredentialsResponse

mix.api.ListApplicationCredentialsResponse schema

{
  "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.co.uk"
        }
      ],
      "createTime": "2020-01-16T15:44:26.008Z",
      "updateTime": "2020-10-23T02:44:57.157Z"
    }
  ]
}

Response object returned by the Get application credentials request.

Properties

Name	Type	Description
credentials	[mix.api.ApplicationCredential]	List of credentials for the application.

mix.api.ListApplicationsResponse

mix.api.ListApplicationsResponse schema

{
  "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.co.uk"
                  },
                  "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
}

Response object returned by the Get list of applications request.

Properties

Name	Type	Description
applications	[mix.api.Application]	List of Mix applications.
totalSize	integer(int32)	Total number of applications that match the request.

mix.api.ListBotConfigsResponse

mix.api.ListBotConfigsResponse schema

{
  "configs": [
    {
      "id": "1386",
      "tag": "TestBotV3",
      "deployments": [
        {
          "id": "339",
          "status": "DEPLOYED",
          "envGeographyDeployments": [
            {
              "id": "1159",
              "envGeography": {
                "id": "338",
                "geography": {
                  "id": "1",
                  "displayName": "Sandbox US"
                },
                "envType": "SANDBOX",
                "envHost": "api.nuance.co.uk"
              },
              "status": "DEPLOYED",
              "deploymentResult": "success",
              "isOverridden": false
            }
          ]
        },
        {
          "id": "340",
          "status": "DEPLOYED",
          "envGeographyDeployments": [
            {
              "id": "1160",
              "envGeography": {
                "id": "339",
                "geography": {
                  "id": "1",
                  "displayName": "Sandbox US"
                },
                "envType": "SANDBOX",
                "envHost": "api.nuance.co.uk"
              },
              "status": "DEPLOYED",
              "deploymentResult": "success",
              "isOverridden": false
            }
          ]
        },
        {
          "id": "341",
          "status": "PENDING_REQUEST",
          "envGeographyDeployments": []
        },
        {
          "id": "342",
          "status": "UNDEPLOYED",
          "envGeographyDeployments": []
        }
      ],
      "parentId": "null",
      "hasInterface": true,
      "createTime": "2021-01-28T01:19:59.415Z"
    }
  ]
}

Response object returned by the Get Bot Configs request.

Properties

Name	Type	Description
configs	[mix.api.BotConfig]	List of application configurations for the bot.

mix.api.ListBotCredentialsResponse

mix.api.ListBotCredentialsResponse schema

{
  "credentials": [
    {
      "id": "522",
      "credential": {
        "id": "272",
        "appId": "mixapi-testbot-dev",
        "clients": [
          {
            "id": "531",
            "clientId": "appID:mixapi-testbot-dev:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:13.178Z",
            "updateTime": "2021-01-18T16:39:13.178Z"
          },
          {
            "id": "535",
            "clientId": "appID:mixapi-testbot-dev:geo:dev:clientName:logging",
            "clientName": "logging",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:03:32.775Z",
            "updateTime": "2021-01-18T17:03:32.775Z"
          }
        ],
        "createTime": "2021-01-18T16:39:13.175Z",
        "updateTime": "2021-01-18T16:39:13.175Z"
      },
      "geographies": [
        {
          "id": "338",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:39:49.151Z",
      "updateTime": "2021-01-18T16:39:49.151Z"
    },
    {
      "id": "523",
      "credential": {
        "id": "273",
        "appId": "mixapi-testbot-qa",
        "clients": [
          {
            "id": "532",
            "clientId": "appID:mixapi-testbot-qa:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:17.915Z",
            "updateTime": "2021-01-18T16:39:17.915Z"
          },
          {
            "id": "538",
            "clientId": "appID:mixapi-testbot-qa:geo:dev:clientName:logging",
            "clientName": "logging",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:04:21.761Z",
            "updateTime": "2021-01-18T17:04:21.761Z"
          }
        ],
        "createTime": "2021-01-18T16:39:17.911Z",
        "updateTime": "2021-01-18T16:39:17.911Z"
      },
      "geographies": [
        {
          "id": "339",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:39:57.024Z",
      "updateTime": "2021-01-18T16:39:57.024Z"
    },
    {
      "id": "524",
      "credential": {
        "id": "274",
        "appId": "mixapi-testbot-stage",
        "clients": [
          {
            "id": "533",
            "clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:21.056Z",
            "updateTime": "2021-01-18T16:39:21.056Z"
          },
          {
            "id": "537",
            "clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:logging",
            "clientName": "logging",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:04:16.400Z",
            "updateTime": "2021-01-18T17:04:16.400Z"
          }
        ],
        "createTime": "2021-01-18T16:39:21.053Z",
        "updateTime": "2021-01-18T16:39:21.053Z"
      },
      "geographies": [
        {
          "id": "340",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:40:02.936Z",
      "updateTime": "2021-01-18T16:40:02.936Z"
    },
    {
      "id": "525",
      "credential": {
        "id": "274",
        "appId": "mixapi-testbot-stage",
        "clients": [
          {
            "id": "533",
            "clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:21.056Z",
            "updateTime": "2021-01-18T16:39:21.056Z"
          },
          {
            "id": "537",
            "clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:logging",
            "clientName": "logging",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:04:16.400Z",
            "updateTime": "2021-01-18T17:04:16.400Z"
          }
        ],
        "createTime": "2021-01-18T16:39:21.053Z",
        "updateTime": "2021-01-18T16:39:21.053Z"
      },
      "geographies": [
        {
          "id": "343",
          "geography": {
            "id": "16",
            "displayName": "Canada"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:40:07.748Z",
      "updateTime": "2021-01-18T16:40:07.748Z"
    },
    {
      "id": "526",
      "credential": {
        "id": "275",
        "appId": "mixapi-testbot-prod",
        "clients": [
          {
            "id": "534",
            "clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:25.297Z",
            "updateTime": "2021-01-18T16:39:25.297Z"
          },
          {
            "id": "536",
            "clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:neap",
            "clientName": "neap",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:03:39.865Z",
            "updateTime": "2021-01-18T17:03:39.865Z"
          }
        ],
        "createTime": "2021-01-18T16:39:25.294Z",
        "updateTime": "2021-01-18T16:39:25.294Z"
      },
      "geographies": [
        {
          "id": "341",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:40:15.046Z",
      "updateTime": "2021-01-18T16:40:15.046Z"
    },
    {
      "id": "527",
      "credential": {
        "id": "275",
        "appId": "mixapi-testbot-prod",
        "clients": [
          {
            "id": "534",
            "clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:default",
            "clientName": "default",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T16:39:25.297Z",
            "updateTime": "2021-01-18T16:39:25.297Z"
          },
          {
            "id": "536",
            "clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:neap",
            "clientName": "neap",
            "oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
            "createTime": "2021-01-18T17:03:39.865Z",
            "updateTime": "2021-01-18T17:03:39.865Z"
          }
        ],
        "createTime": "2021-01-18T16:39:25.294Z",
        "updateTime": "2021-01-18T16:39:25.294Z"
      },
      "geographies": [
        {
          "id": "342",
          "geography": {
            "id": "16",
            "displayName": "Canada"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ],
      "createTime": "2021-01-18T16:40:36.728Z",
      "updateTime": "2021-01-18T16:40:36.728Z"
    }
  ]
}

Response object returned by the Get Bot Credentials request.

Properties

Name	Type	Description
credentials	[mix.api.BotCredential]	List of credentials for the bot.

mix.api.ListBotsResponse

mix.api.ListBotsResponse schema

{
  "bots": [
    {
      "id": "233",
      "applicationName": "Mix.api Test Bot",
      "configs": [
        {
          "id": "1386",
          "tag": "TestBotV3",
          "deployments": [
            {
              "id": "342",
              "status": "PENDING_REQUEST",
              "envGeographyDeployments": []
            },
            {
              "id": "341",
              "status": "UNDEPLOYED",
              "envGeographyDeployments": []
            },
            {
              "id": "340",
              "status": "DEPLOYED",
              "envGeographyDeployments": [
                {
                  "id": "1160",
                  "envGeography": {
                    "id": "339",
                    "geography": {
                      "id": "14",
                      "displayName": "US"
                    },
                    "envType": "SANDBOX",
                    "envHost": "api.nuance.co.uk",
                    "envName": "QA"
                  },
                  "status": "DEPLOYED",
                  "deploymentResult": "success",
                  "isOverridden": false,
                  "dataHosts": []
                }
              ]
            },
            {
              "id": "339",
              "status": "PENDING_REQUEST",
              "envGeographyDeployments": []
            }
          ],
          "parentId": "",
          "hasInterface": true,
          "deploymentFlowId": 263,
          "createTime": "2021-01-28T01:19:59Z"
        }
      ],
      "createTime": "2021-01-18T16:39:02Z"
    }
  ],
  "totalSize": 1
}

Response object returned by the Get Bots list request.

Properties

Name	Type	Description
bots	[mix.api.Bot]	List of bots.
totalSize	integer(int32)	Total number of bots that match the request.

mix.api.ListBuildsResponse

mix.api.ListBuildsResponse schema

{
  "projectId": "23079",
  "builds": [
    {
      "projectId": "23079",
      "buildLabel": "NLU_23079_1",
      "buildId": "1955",
      "buildType": "NLU",
      "buildVersion": "1",
      "status": "BST_COMPLETED",
      "languageTopic": "gen",
      "datapack": {
        "displayName": "en-US",
        "version": "4.7.0"
      },
      "notes": "First build",
      "createTime": "2021-01-18T16:51:42.049Z",
      "modelType": "LEGACY",
      "dataSources": [
        "nuance_custom_data"
      ]
    },
    {
      "projectId": "23079",
      "buildLabel": "NLU_23079_2",
      "buildId": "1956",
      "buildType": "NLU",
      "buildVersion": "2",
      "status": "BST_COMPLETED",
      "languageTopic": "gen",
      "datapack": {
        "displayName": "en-US",
        "version": "4.7.0"
      },
      "notes": "Update for ASR and NLU only",
      "createTime": "2021-01-18T16:56:04.140Z",
      "modelType": "LEGACY",
      "dataSources": [
        "nuance_custom_data"
      ]
    }
  ],
  "totalSize": 2,
  "count": 2,
  "limit": 10,
  "offset": 0
}

Response object returned by the Get builds request.

Properties

Name	Type	Description
projectId	string	ID of the project.
builds	[mix.api.GetBuildResponse]	Build details.
totalSize	integer(int32)	Total number of builds that match the request.
count	integer(int32)	Number of results returned.
limit	integer(int32)	Value of limit field specified in request.
offset	integer(int32)	Value of offset field specified in request.

mix.api.ListDataHostsResponse

mix.api.ListDataHostsResponse schema

{
  "dataHosts": [
    {
      "id": "200",
      "alias": "COFFEE_APP",
      "environmentId": "57",
      "environmentGeographyId": "1",
      "value": "https://coffee.app.com:443"
    }
  ]
}

Response object returned by the Get data hosts request.

Properties

Name	Type	Description
dataHosts	[mix.api.DataHost]	List of data hosts.

mix.api.ListDataTypesResponse

mix.api.ListDataTypesResponse schema

{
  "dataTypes": [
    {
      "name": "BOOLEAN",
      "schema": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "BOOLEAN",
        "type": "boolean",
        "description": "Programmatic True or False",
        "properties": {}
      },
      "compatibleEntityTypes": [
        {
          "type": "LIST",
          "default": false,
          "initializer": {
            "literals": [
              {
                "meaning": "true",
                "patterns": [
                  "true"
                ]
              },
              {
                "meaning": "false",
                "patterns": [
                  "false"
                ]
              }
            ]
          }
        },
        {
          "type": "RULE_BASED",
          "default": false
        },
        {
          "type": "RELATIONAL",
          "default": true,
          "initializer": {
            "name": "nuance_BOOLEAN",
            "link": "isA"
          }
        }
      ]
    }
  ]
}

Response object returned by the Get data types request.

Properties

Name	Type	Description
dataTypes	[mix.api.DataTypes]	List of data types.

mix.api.ListDeploymentFlowsResponse

mix.api.ListDeploymentFlowsResponse schema

{
  "flows": [
    {
      "id": "262",
      "displayName": "Default Deployment Flow",
      "steps": [
        {
          "id": "338",
          "step": 1,
          "requiresApproval": false,
          "environments": [
            {
              "id": "300",
              "displayName": "Sandbox",
              "geographies": [
                {
                  "id": "337",
                  "geography": {
                    "id": "9",
                    "displayName": "US"
                  },
                  "envType": "SANDBOX",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "263",
      "displayName": "Multi-Stage Pipeline",
      "steps": [
        {
          "id": "339",
          "step": 1,
          "requiresApproval": false,
          "environments": [
            {
              "id": "301",
              "displayName": "Development",
              "geographies": [
                {
                  "id": "338",
                  "geography": {
                    "id": "14",
                    "displayName": "US"
                  },
                  "envType": "SANDBOX",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        },
        {
          "id": "340",
          "step": 2,
          "requiresApproval": false,
          "environments": [
            {
              "id": "302",
              "displayName": "QA",
              "geographies": [
                {
                  "id": "339",
                  "geography": {
                    "id": "14",
                    "displayName": "US"
                  },
                  "envType": "SANDBOX",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        },
        {
          "id": "341",
          "step": 3,
          "requiresApproval": false,
          "environments": [
            {
              "id": "303",
              "displayName": "Staging",
              "geographies": [
                {
                  "id": "340",
                  "geography": {
                    "id": "14",
                    "displayName": "US"
                  },
                  "envType": "PRODUCTION",
                  "envHost": "api.nuance.co.uk"
                },
                {
                  "id": "343",
                  "geography": {
                    "id": "16",
                    "displayName": "Canada"
                  },
                  "envType": "PRODUCTION",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        },
        {
          "id": "342",
          "step": 4,
          "requiresApproval": true,
          "environments": [
            {
              "id": "304",
              "displayName": "Production",
              "geographies": [
                {
                  "id": "341",
                  "geography": {
                    "id": "14",
                    "displayName": "US"
                  },
                  "envType": "PRODUCTION",
                  "envHost": "api.nuance.co.uk"
                },
                {
                  "id": "342",
                  "geography": {
                    "id": "16",
                    "displayName": "Canada"
                  },
                  "envType": "PRODUCTION",
                  "envHost": "api.nuance.co.uk"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totalSize": 2,
  "count": 2,
  "limit": 10,
  "offset": 0
}

Response object returned by the Get Deployment Flows list request.

Properties

Name	Type	Description
flows	[mix.api.DeploymentFlow]	List of deployment flows.
totalSize	integer(int32)	Total number of deployment flows that match the request.
count	integer(int32)	Number of results returned.
limit	integer(int32)	Value of limit field specified in request.
offset	integer(int32)	Value of offset field specified in request.

mix.api.ListEnginePacksResponse

mix.api.ListEnginePacksResponse schema

{
  "enginePacks": [
    {
      "enginePackId": "d5262497-afa2-4cdf-9d3d-1a3fd70bc0c6",
      "version": "hosted",
      "dialogVersion": "1.0.0",
      "nluVersion": "1.1.0",
      "asrVersion": "1.2.4",
      "ttsVersion": "1.2.0",
      "isDefault": false,
      "topics": {
        "gen": {
          "locales": {
            "fr-CA": {
              "versions": [
                {
                  "version": "4.1.0",
                  "isSupported": true
                },
                {
                  "version": "4.0.0",
                  "isSupported": true
                }
              ]
            },
            "id-ID": {
              "versions": [
                {
                  "version": "4.0.0",
                  "isSupported": true
                }
              ]
            },
            "pt-BR": {
              "versions": [
                {
                  "version": "4.2.0",
                  "isSupported": true
                }
              ]
            },
            "th-TH": {
              "versions": [
                {
                  "version": "4.0.0",
                  "isSupported": true
                }
              ]
            },
            "fr-FR": {
              "versions": [
                {
                  "version": "4.1.0",
                  "isSupported": true
                }
              ]
            },
            "en-US": {
              "versions": [
                {
                  "version": "4.7.0",
                  "isSupported": true
                },
                {
                  "version": "4.5.0",
                  "isSupported": true
                },
                {
                  "version": "4.4.0",
                  "isSupported": true
                },
                {
                  "version": "4.2.0",
                  "isSupported": true
                }
              ]
            }
          }
        }
      }
    }
  ]
}

Response object returned by the Get engine packs request.

Properties

Name	Type	Description
enginePacks	[mix.api.EnginePack]	[Message that defines an engine pack.]

mix.api.ListEntitiesRequest.EntityType

mix.api.ListEntitiesRequest.EntityType schema

"UNSPECIFIED"

ENUM that defines the entity types.

• UNSPECIFIED: No type specified
• BASE: Base entity
• RELATIONAL: Relationship entity
• LIST: List entity
• FREEFORM: Freeform entity
• REGEX: Regex-based entity
• RULE_BASED: Rule-based entity

mix.api.ListEntitiesResponse

mix.api.ListEntitiesResponse schema

{
  "entities": [
    {
      "baseEntity": {
        "id": "1d6ea576-1305-47b4-bfba-667ae1935b31",
        "name": "AND",
        "dataType": "NOT_SET"
      }
    },
    {
      "baseEntity": {
        "id": "316009ea-f5a9-40d9-ab77-e2fc268a6f41",
        "name": "NOT",
        "dataType": "NOT_SET"
      }
    },
    {
      "baseEntity": {
        "id": "ddd3faad-a26b-4a0a-839f-88b71c9fbc32",
        "name": "OR",
        "dataType": "NO_FORMAT"
      }
    },
    {
      "baseEntity": {
        "id": "9bb99448-0400-4f3b-9edf-73ed13698ea4",
        "name": "nuance_AMOUNT",
        "dataType": "NOT_SET"
      }
    },
    {
      "listEntity": {
        "id": "bc6c1470-a2a5-4d01-976a-b682a5af6f66",
        "name": "COFFEE_SIZE",
        "isDynamic": false,
        "numLiterals": 5,
        "settings": {
          "isSensitive": false,
          "canonicalize": true
        },
        "dataType": "NO_FORMAT"
      }
    },
    {
      "listEntity": {
        "id": "73cb7c26-fed5-4331-8701-6736d98c40d6",
        "name": "COFFEE_TYPE",
        "isDynamic": false,
        "numLiterals": 9,
        "settings": {
          "isSensitive": false,
          "canonicalize": true
        },
        "dataType": "NO_FORMAT"
      }
    }
  ]
}

Response object returned by the List entities request.

Properties

Name	Type	Description
entities	[mix.api.EntityResponse]	List of entities.

mix.api.ListEntity

mix.api.ListEntity schema

{
  "id": "string",
  "name": "string",
  "isDynamic": true,
  "anaphora": "ANAPHORA_NOT_SET",
  "numLiterals": 0,
  "dataSource": "string",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Entity type used for recognizing a value from a list of finite literals.

Properties

Name	Type	Description
id	string	UUID of the entity.
name	string	Entity name.
isDynamic	boolean	When set to true, indicates that the entity is dynamic.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
numLiterals	integer(int32)	Number of literals that exist for this entity.
dataSource	string	Data source used for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.ListEntityCreateRequest

mix.api.ListEntityCreateRequest schema

{
  "name": "string",
  "isDynamic": true,
  "anaphora": "ANAPHORA_NOT_SET",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET",
  "data": {
    "property1": {
      "entries": [
        {
          "meaning": "string",
          "patterns": [
            "string"
          ]
        }
      ]
    },
    "property2": {
      "entries": [
        {
          "meaning": "string",
          "patterns": [
            "string"
          ]
        }
      ]
    }
  }
}

Request object for creating a list entity.

Properties

Name	Type	Description
name	string	Entity name.
isDynamic	boolean	When set to true, indicates that the entity is dynamic.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.
data	object	List entity initialization data; key is a valid project locale.

mix.api.ListEntityData

mix.api.ListEntityData schema

{
  "entries": [
    {
      "meaning": "string",
      "patterns": [
        "string"
      ]
    }
  ]
}

List entity initialization data.

Properties

Name	Type	Description
entries	[mix.api.ListEntityDataEntry]	List entity initialization data entry.

mix.api.ListEntityDataEntry

mix.api.ListEntityDataEntry schema

{
  "meaning": "string",
  "patterns": [
    "string"
  ]
}

List entity initialization data entry.

Properties

Name	Type	Description
meaning	string	Entity meaning.
patterns	[string]	List of entity patterns.

mix.api.ListEntityTypesResponse

mix.api.ListEntityTypesResponse schema

{
  "entityTypes": [
    {
      "name": "BASE",
      "description": "Predefined Nuance Entity",
      "initializer": {},
      "comaptibleDataTypes": [
        "NO_FORMAT"
      ]
    }
  ]
}

Response object returned by the Get entity types request.

Properties

Name	Type	Description
entityTypes	[mix.api.EntityTypes]	List of entity types.

mix.api.ListEntityUpdateRequest

mix.api.ListEntityUpdateRequest schema

{
  "isDynamic": true,
  "anaphora": "ANAPHORA_NOT_SET",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET",
  "data": {
    "property1": {
      "entries": [
        {
          "meaning": "string",
          "patterns": [
            "string"
          ]
        }
      ]
    },
    "property2": {
      "entries": [
        {
          "meaning": "string",
          "patterns": [
            "string"
          ]
        }
      ]
    }
  }
}

Request object for updating a list entity.

Properties

Name	Type	Description
isDynamic	boolean	When set to true, indicates that the entity is dynamic.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.
data	object	List entity data to be added; key is a valid project locale.

mix.api.ListEnvironmentsResponse

mix.api.ListEnvironmentsResponse schema

{
  "environments": [
    {
      "id": "300",
      "displayName": "Sandbox",
      "geographies": [
        {
          "id": "337",
          "geography": {
            "id": "1",
            "displayName": "Sandbox US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ]
    },
    {
      "id": "301",
      "displayName": "Development",
      "geographies": [
        {
          "id": "338",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ]
    },
    {
      "id": "302",
      "displayName": "QA",
      "geographies": [
        {
          "id": "339",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "SANDBOX",
          "envHost": "api.nuance.co.uk"
        }
      ]
    },
    {
      "id": "303",
      "displayName": "Staging",
      "geographies": [
        {
          "id": "340",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        },
        {
          "id": "343",
          "geography": {
            "id": "16",
            "displayName": "Canada"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ]
    },
    {
      "id": "304",
      "displayName": "Production",
      "geographies": [
        {
          "id": "341",
          "geography": {
            "id": "14",
            "displayName": "US"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        },
        {
          "id": "342",
          "geography": {
            "id": "16",
            "displayName": "Canada"
          },
          "envType": "PRODUCTION",
          "envHost": "api.nuance.co.uk"
        }
      ]
    }
  ],
  "totalSize": 5,
  "count": 5,
  "limit": 10,
  "offset": 0
}

Response object returned by the Get Environments list request.

Properties

Name	Type	Description
environments	[mix.api.Environment]	List of environments.
totalSize	integer(int32)	Total number of environments that match the request.
count	integer(int32)	Number of results returned.
limit	integer(int32)	Value of limit field specified in request.
offset	integer(int32)	Value of offset field specified in request.

mix.api.ListExtendedProjectsResponse

mix.api.ListExtendedProjectsResponse schema

{
  "projects": [
    {
      "id": "23079",
      "displayName": "GA Bank Demo",
      "languageTopic": "gen",
      "channels": [
        {
          "channel": {
            "id": "454bea86-0e77-49b4-b527-0188d46a52c2",
            "displayName": "Omni Channel VA",
            "codeName": "custom",
            "modes": [
              "INTERACTIVITY",
              "AUDIO_SCRIPT",
              "TTS",
              "RICH_TEXT"
            ],
            "color": "PURPLE"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "42dcfbf7-86b2-46f8-b495-0d3bf7907248",
            "displayName": "Digital VA",
            "codeName": "custom",
            "modes": [
              "RICH_TEXT",
              "TTS",
              "INTERACTIVITY"
            ],
            "color": "GREEN"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "bd47faf3-ec97-4f63-ac8d-53f7822c2d24",
            "displayName": "IVR Voice VA",
            "codeName": "custom",
            "modes": [
              "AUDIO_SCRIPT"
            ],
            "color": "LIGHT_ORANGE"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "23371c6d-2760-4aed-af6e-13c75d86f3a6",
            "displayName": "Default",
            "codeName": "default",
            "modes": [
              "INTERACTIVITY",
              "RICH_TEXT",
              "TTS",
              "AUDIO_SCRIPT"
            ],
            "color": "COLOR_UNSPECIFIED"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "88544ae0-9fe1-4a3b-b7eb-129614c3532a",
            "displayName": "Text VA",
            "codeName": "custom",
            "modes": [
              "RICH_TEXT"
            ],
            "color": "CORN_FLOWER"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "8e432bd2-6512-4da3-8236-66a6f94b6e44",
            "displayName": "Audio VA",
            "codeName": "custom",
            "modes": [
              "TTS"
            ],
            "color": "PINK"
          },
          "isActive": true
        }
      ],
      "datapacks": [
        {
          "displayName": "fr-FR",
          "version": "4.1.0",
          "isActive": true,
          "isDefault": false
        },
        {
          "displayName": "en-US",
          "version": "4.7.0",
          "isActive": true,
          "isDefault": true
        }
      ],
      "isFavorite": false,
      "orgId": "233",
      "orgDisplayName": "Mix.api Test Organization",
      "policy": {
        "isAccepted": true,
        "projectDescription": "",
        "createTime": "2021-08-12T11:58:10Z",
        "updateTime": "2021-08-12T11:58:10Z"
      },
      "createTime": "2021-01-18T16:44:58Z",
      "updateTime": "2021-01-28T19:23:27Z",
      "baseDatapack": "9.4.4",
      "enginePackFeatures": [
        "xmix-3458_spacing-flag",
        "xmix-3774_qa-sensitive"
      ],
      "lastSavedTime": "2021-08-16T13:04:12Z",
      "lastUsedTime": "2021-08-16T11:59:08Z",
      "lastAsrModelCreateTime": "2021-01-28T01:19:00Z",
      "lastNluModelCreateTime": "2021-01-28T01:18:58Z",
      "lastDialogModelCreateTime": "2021-01-28T01:19:03Z"
    }
  ],
  "count": 1,
  "totalSize": 1,
  "limit": 10,
  "offset": 0
}

Response object returned by the Get list of Mix projects request.

Properties

Name	Type	Description
projects	[mix.api.ExtendedProject]	List of ExtendedProject objects, which provide an extended set of project attributes.
count	integer(int32)	Total number of projects in the result.
totalSize	integer(int32)	Total number of projects that match the request, if applicable.
limit	integer(int32)	Value of limit field specified in request, if applicable.
offset	integer(int32)	Value of offset field specified in request, if applicable.

mix.api.ListGeographiesResponse

mix.api.ListGeographiesResponse schema

{
  "geographies": [
    {
      "id": "1",
      "displayName": "Sandbox US"
    },
    {
      "id": "14",
      "displayName": "US"
    },
    {
      "id": "16",
      "displayName": "Canada"
    }
  ],
  "totalSize": 3,
  "count": 3,
  "limit": 10,
  "offset": 0
}

Response object returned by the Get Geographies list request.

Properties

Name	Type	Description
geographies	[mix.api.Geography]	List of geographies.
totalSize	integer(int32)	Total number of geographies that match the request.
count	integer(int32)	Number of results returned.
limit	integer(int32)	Value of limit field specified in request.
offset	integer(int32)	Value of offset field specified in request.

mix.api.ListIntentsResponse

mix.api.ListIntentsResponse schema

{
  "intents": [
    {
      "id": "416ceedc-a18d-4bb0-a0aa-d1abcdd69283",
      "name": "NO_INTENT",
      "isInBaseOntology": true,
      "links": []
    },
    {
      "id": "a9e7428a-5c12-4ead-9aad-c6b7d8723ee7",
      "name": "ORDER_COFFEE",
      "isInBaseOntology": false,
      "links": [
        {
          "entityRef": "COFFEE_SIZE"
        },
        {
          "entityRef": "COFFEE_TYPE"
        }
      ]
    },
    {
      "id": "1f9004f5-e0d1-4c23-98c0-49229a2c07da",
      "name": "nuance_weather_query",
      "isInBaseOntology": false,
      "links": [
        {
          "entityRef": "nuance_common_datetime"
        },
        {
          "entityRef": "nuance_common_location"
        },
        {
          "entityRef": "nuance_common_relative_location"
        },
        {
          "entityRef": "nuance_weather_condition"
        }
      ],
      "dataSource": "nuance_weather"
    }
  ]
}

Response object returned by the Get intents request.

Properties

Name	Type	Description
intents	[mix.api.IntentResponse]	List of intents.

mix.api.ListLanguageTopicsResponse

mix.api.ListLanguageTopicsResponse schema

{
  "languageTopics": [
    {
      "id": "1",
      "name": "gen",
      "locales": [
        {
          "locale": "fr-CA",
          "language": "fr",
          "country": "CA",
          "displayLanguage": "French",
          "displayCountry": "Canada"
        },
        {
          "locale": "en-US",
          "language": "en",
          "country": "US",
          "displayLanguage": "English",
          "displayCountry": "United States",
          "versions": [
            "4.7.0",
            "4.5.0",
            "4.4.0",
            "4.2.0"
          ]
        }
      ]
    }
  ]
}

Response object returned by the Get Language Topics list request.

Properties

Name	Type	Description
languageTopics	[mix.api.LanguageTopic]	List of language topics.

mix.api.ListLatestBuildsResponse

mix.api.ListLatestBuildsResponse schema

{
  "models": {
    "asr": {
      "builds": [
        {
          "locale": "en-US",
          "buildVersion": "6",
          "buildLabel": "ASR_23079_6"
        }
      ],
      "projectId": "23079"
    },
    "nlu": {
      "builds": [
        {
          "locale": "en-US",
          "buildVersion": "6",
          "buildLabel": "NLU_23079_6"
        }
      ],
      "projectId": "23079"
    },
    "dialog": {
      "projectId": "23079",
      "buildVersion": "7",
      "buildLabel": "DIALOG_23079_7"
    }
  }
}

Response object returned by the Get latest builds request.

Properties

Name	Type	Description
models	mix.api.ModelsContent	List of build models.

mix.api.ListLatestDataHostsResponse

mix.api.ListLatestDataHostsResponse schema

{
  "dataHosts": [
    {
      "id": "200",
      "alias": "COFFEE_APP",
      "environmentId": "39",
      "environmentGeographyId": "1",
      "value": "https://coffee.app.com:443"
    },
    {
      "id": "518",
      "alias": "LOCAL",
      "environmentId": "39",
      "environmentGeographyId": "1",
      "value": "http://dataaccess-examples.local/dataaccess-examples/"
    }
  ]
}

Response object returned by the Get latest data hosts request.

Properties

Name	Type	Description
dataHosts	[mix.api.DataHost]	List of latest data hosts.

mix.api.ListOrganizationsResponse

mix.api.ListOrganizationsResponse schema

{
  "organizations": [
    {
      "id": "233",
      "displayName": "Mix.api Test Organization",
      "type": "STANDARD",
      "members": [
        {
          "member": {
            "id": "36",
            "email": "alex.smith@company.com",
            "name": "Alex Smith",
            "createTime": "2020-01-16T15:44:25.231Z",
            "lastLoginTime": "2021-01-26T13:07:16.644Z"
          },
          "roles": [
            {
              "id": "2",
              "displayName": "member",
              "description": "Can see the organization details and collaborate on projects/applications."
            }
          ]
        }
      ],
      "isDeepLearningModelEnabled": true,
      "isEnginePacksEnabled": false,
      "isDataPacksEnabled": false
    },
    {
      "id": "37",
      "displayName": "alex.smith@company.com",
      "type": "PERSONAL",
      "members": [
        {
          "member": {
            "id": "36",
            "email": "alex.smith@company.com",
            "name": "Alex Smith",
            "createTime": "2020-01-16T15:44:25.231Z",
            "lastLoginTime": "2021-01-26T13:07:16.644Z"
          },
          "roles": [
            {
              "id": "1",
              "displayName": "owner",
              "description": "Can invite users, edit organization details, and create projects and applications."
            }
          ]
        }
      ],
      "isDeepLearningModelEnabled": false,
      "isEnginePacksEnabled": true,
      "isDataPacksEnabled": false
    }
  ],
  "totalSize": 1,
  "count": 1,
  "limit": 0,
  "offset": 0
}

Response object returned by the Get Organizations list request.

Properties

Name	Type	Description
organizations	[mix.api.Organization]	List of organizations.
totalSize	integer(int32)	Total number of organizations that match the request.
count	integer(int32)	Number of results returned.
limit	integer(int32)	Value of limit field specified in request.
offset	integer(int32)	Value of offset field specified in request.

mix.api.ListProjectJobsResponse

mix.api.ListProjectJobsResponse schema

{
  "jobs": [
    {
      "id": "430a4626-3b41-4fa2-bb8b-db1c7c2c7189",
      "type": "APPEND_INTENT_SAMPLES",
      "projectId": "2960",
      "status": "COMPLETED",
      "createTime": "2021-06-08T21:10:37.456Z",
      "updateTime": "2021-06-08T21:10:52.052Z",
      "duration": "14.596s"
    }
  ],
  "totalSize": 1,
  "count": 1,
  "limit": 10,
  "offset": 0
}

Response object returned by the Get jobs request.

Properties

Name	Type	Description
jobs	[mix.api.JobResponse]	List of jobs for the project specified.
totalSize	integer(int32)	Total number of jobs that match the request.
count	integer(int32)	Number of results returned.
limit	integer(int32)	Value of limit field specified in request.
offset	integer(int32)	Value of offset field specified in request.

mix.api.ListProjectsLocksResponse

mix.api.ListProjectsLocksResponse schema

{
  "locks": [
    {
      "lockId": "2",
      "projectId": "21647",
      "lockOwner": {
        "id": "1",
        "email": "admin@company.com"
      },
      "notes": "Building models",
      "createTime": "2021-11-04T14:55:36Z"
    },
    {
      "lockId": "18",
      "projectId": "2960",
      "lockOwner": {
        "id": "36",
        "email": "alex.smith@company.com"
      },
      "notes": "Exporting model",
      "createTime": "2021-11-10T15:33:35Z"
    }
  ],
  "totalSize": 2,
  "count": 2,
  "limit": 10,
  "offset": 0
}

Response object returned by the Get project locks request.

Properties

Name	Type	Description
locks	[mix.api.ProjectLock]	List of project locks.
totalSize	integer(int32)	Total number of locks that match the request.
count	integer(int32)	Number of results returned.
limit	integer(int32)	Value of limit field specified in request.
offset	integer(int32)	Value of offset field specified in request.

mix.api.ListProjectsResponse

mix.api.ListProjectsResponse schema

{
  "projects": [
    {
      "id": "23079",
      "displayName": "GA Bank Demo",
      "languageTopic": "gen",
      "channels": [
        {
          "channel": {
            "id": "33428",
            "displayName": "Audio VA",
            "codeName": "Audio VA",
            "modes": [
              "TTS"
            ],
            "color": "PINK"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "33427",
            "displayName": "Text VA",
            "codeName": "Text VA",
            "modes": [
              "RICH_TEXT"
            ],
            "color": "CORN_FLOWER"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "33426",
            "displayName": "Digital VA",
            "codeName": "Digital VA",
            "modes": [
              "INTERACTIVITY",
              "RICH_TEXT",
              "TTS"
            ],
            "color": "GREEN"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "33425",
            "displayName": "IVR/Voice VA",
            "codeName": "IVR/Voice VA",
            "modes": [
              "AUDIO_SCRIPT",
              "DTMF"
            ],
            "color": "LIGHT_ORANGE"
          },
          "isActive": true
        },
        {
          "channel": {
            "id": "33424",
            "displayName": "Omni Channel VA",
            "codeName": "Omni Channel VA",
            "modes": [
              "AUDIO_SCRIPT",
              "DTMF",
              "INTERACTIVITY",
              "RICH_TEXT",
              "TTS"
            ],
            "color": "PURPLE"
          },
          "isActive": true
        }
      ],
      "datapacks": [
        {
          "displayName": "fr-FR",
          "version": "4.1.0",
          "isActive": true
        },
        {
          "displayName": "en-US",
          "version": "4.7.0",
          "isActive": true
        }
      ],
      "orgId": "2",
      "createTime": "2021-01-18T16:44:58.947Z",
      "updateTime": "2021-01-18T16:45:56Z"
    }
  ]
}

Response object returned by the Get projects request.

Properties

Name	Type	Description
projects	[mix.api.Project]	List of projects.

mix.api.LockProjectResponse

mix.api.LockProjectResponse schema

{
  "lock": {
    "lockId": "18",
    "projectId": "2960",
    "lockOwner": {
      "id": "36",
      "email": "alex.smith@company.com"
    },
    "notes": "Exporting model",
    "createTime": "2021-11-10T15:33:35Z"
  }
}

Response object returned by the Lock project request.

Properties

Name	Type	Description
lock	mix.api.ProjectLock	Project lock instance, if available.

mix.api.LockRequest

mix.api.LockRequest schema

{
  "notes": "string"
}

Message that defines the project lock notes.

Properties

Name	Type	Description
notes	string	Project lock notes.

mix.api.Modality

mix.api.Modality schema

"MODE_UNSPECIFIED"

Enum that defines the modalities in a channel.

• MODE_UNSPECIFIED: Unspecified mode
• RICH_TEXT: Rich text mode; used for text messages that can be displayed on any screen, such as SMS messages
• TTS: TTS mode; used for text that can be spoken using speech synthesis
• INTERACTIVITY: Interactivity mode; used to add interactive elements to a message, such as buttons and clickable links
• AUDIO_SCRIPT: Audio script mode; used to specify recorded audio files to play, as well as backup text to be rendered using TTS
• DTMF: DTMF mode; used to add support for Dual-Tone Multi-Frequency tones as user input

mix.api.ModelsContent

mix.api.ModelsContent schema

{
  "asr": {
    "builds": [
      {
        "locale": "string",
        "buildVersion": "string",
        "buildLabel": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ],
    "projectId": "string"
  },
  "nlu": {
    "builds": [
      {
        "locale": "string",
        "buildVersion": "string",
        "buildLabel": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    ],
    "projectId": "string"
  },
  "dialog": {
    "projectId": "string",
    "buildVersion": "string",
    "buildLabel": "string",
    "createTime": "2019-08-24T14:15:22Z"
  }
}

Message that defines a list of build models.

Properties

Name	Type	Description
asr	mix.api.BaseModelContent	ASR model.
nlu	mix.api.BaseModelContent	NLU model.
dialog	mix.api.DialogBuildContent	Dialog model.

mix.api.NLUBody

mix.api.NLUBody schema

{
  "notes": "string",
  "settings": {
    "modelType": "LEGACY"
  }
}

Message that defines an NLU build.

Properties

Name	Type	Description
notes	string	Notes specified when starting the build.
settings	mix.api.NLUModelSettings	Message that defines settings for the NLU model.

mix.api.NLUModelSettings

mix.api.NLUModelSettings schema

{
  "modelType": "LEGACY"
}

Object defines the NLU model settings.

Properties

Name	Type	Description
modelType	mix.api.NLUModelType	NLU model type.

mix.api.NLUModelType

mix.api.NLUModelType schema

"LEGACY"

ENUM that defines the type of NLU model to use when building.

• FAST: Deprecated. Renamed to LEGACY
• ACCURATE: Deprecated. Renamed to DEEP_LEARNING

mix.api.Organization

mix.api.Organization schema

{
  "id": "string",
  "displayName": "string",
  "type": "TYPE_UNSPECIFIED",
  "members": [
    {
      "member": {
        "id": "string",
        "email": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "lastLoginTime": "2019-08-24T14:15:22Z",
        "name": "string"
      },
      "roles": [
        {
          "id": "string",
          "displayName": "string",
          "description": "string"
        }
      ]
    }
  ],
  "isDeepLearningModelEnabled": true,
  "isEnginePacksEnabled": true,
  "isDataPacksEnabled": true
}

Message that defines an organization.

Properties

Name	Type	Description
id	string	Unique ID identifying the organization.
displayName	string	Name of the organization.
type	mix.api.OrganizationType	Type of organization.
members	[mix.api.OrganizationMember]	List of members in the organization.
isDeepLearningModelEnabled	boolean	When set to true, DEEP_LEARNING model build is enabled.
isEnginePacksEnabled	boolean	When set to true, engine pack selection is enabled.
isDataPacksEnabled	boolean	When set to true, data pack selection is enabled.

mix.api.OrganizationMember

mix.api.OrganizationMember schema

{
  "member": {
    "id": "string",
    "email": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "lastLoginTime": "2019-08-24T14:15:22Z",
    "name": "string"
  },
  "roles": [
    {
      "id": "string",
      "displayName": "string",
      "description": "string"
    }
  ]
}

Message that defines the roles assigned to a specific member.

Properties

Name	Type	Description
member	mix.api.User	User that is a member of an organization.
roles	[mix.api.OrganizationRole]	List of roles assigned to this member.

mix.api.OrganizationRole

mix.api.OrganizationRole schema

{
  "id": "string",
  "displayName": "string",
  "description": "string"
}

Message that defines the roles available in an organization.

Properties

Name	Type	Description
id	string	Unique ID identifying the role.
displayName	string	Name of the role.
description	string	Description of the role.

mix.api.OrganizationType

mix.api.OrganizationType schema

"TYPE_UNSPECIFIED"

Input field that specifies the type of organization.

• TYPE_UNSPECIFIED: All types of organizations
• PERSONAL: User's personal organization, identified with the user's email address
• STANDARD: Global organization, such as a company, that typically includes many members

mix.api.OrganizationView

mix.api.OrganizationView schema

"VIEW_UNSPECIFIED"

Input field that specifies the organization information returned.

• VIEW_UNSPECIFIED: Returns organization details without listing the organization members
• FULL: Returns all organization details, including the list of organization members

mix.api.OverrideApplicationConfigContent

mix.api.OverrideApplicationConfigContent schema

{
  "dataHosts": [
    {
      "id": "string",
      "alias": "string",
      "environmentId": "string",
      "environmentGeographyId": "string",
      "value": "string"
    }
  ],
  "requestModels": {
    "asr": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "nlu": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "dialog": {
      "buildLabel": "string"
    }
  }
}

Message that defines the content used to override an existing application configuration.

Properties

Name	Type	Description
dataHosts	[mix.api.DataHost]	List of data hosts.
requestModels	mix.api.RequestModelsContent	List of models for this application configuration.

mix.api.OverrideApplicationConfigResponse

mix.api.OverrideApplicationConfigResponse schema

{
  "config": {
    "id": "string",
    "tag": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "deployments": [
      {
        "id": "string",
        "status": "STATUS_UNSPECIFIED",
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z",
        "envGeographyDeployments": [
          {
            "id": null,
            "envGeography": null,
            "status": null,
            "deploymentResult": null,
            "isOverridden": null,
            "requestedBy": null,
            "approvedBy": null,
            "dataHosts": null,
            "createdAt": null,
            "approvedAt": null,
            "approvalRequired": null
          }
        ]
      }
    ],
    "parentId": "string",
    "deploymentFlowId": 0,
    "builds": {
      "asr": {
        "builds": [
          {}
        ],
        "projectId": "string"
      },
      "nlu": {
        "builds": [
          {}
        ],
        "projectId": "string"
      },
      "dialog": {
        "projectId": "string",
        "buildVersion": "string",
        "buildLabel": "string",
        "createTime": "2019-08-24T14:15:22Z"
      }
    },
    "projectDetails": {
      "projectId": "string",
      "projectName": "string",
      "isChildDataCompliant": true,
      "projectDescription": "string"
    }
  }
}

Response object returned by the Override application configuration request.

Properties

Name	Type	Description
config	mix.api.ApplicationConfig	Application configuration.

mix.api.Project

mix.api.Project schema

{
  "id": "string",
  "displayName": "string",
  "languageTopic": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z",
  "channels": [
    {
      "channel": {
        "id": "string",
        "displayName": "string",
        "codeName": "string",
        "modes": [
          "MODE_UNSPECIFIED"
        ],
        "color": "COLOR_UNSPECIFIED"
      },
      "isActive": true
    }
  ],
  "datapacks": [
    {
      "isActive": true,
      "displayName": "string",
      "version": "string",
      "isDefault": true
    }
  ],
  "baseDatapack": "string",
  "enginePackId": "string",
  "orgId": "string"
}

Message that defines a project.

Properties

Name	Type	Description
id	string	Unique ID identifying the project.
displayName	string	Project name.
languageTopic	string	Project language topic.
createTime	string(date-time)	Date and time the project was created.
updateTime	string(date-time)	Date and time the project was last updated.
channels	[mix.api.ChannelTarget]	List of channels available in this project.
datapacks	[mix.api.CoreDatapack]	List of core data packs available in this project.
baseDatapack	string	QuickNLP data pack used in this project.
enginePackId	string	The ID of the engine pack associated with this project, if defined.
orgId	string	ID identifying the organization for this project.

mix.api.ProjectDetails

mix.api.ProjectDetails schema

{
  "projectId": "string",
  "projectName": "string",
  "isChildDataCompliant": true,
  "projectDescription": "string"
}

Message that defines the project details for an application configuration.

Properties

Name	Type	Description
projectId	string	Project ID.
projectName	string	Project name.
isChildDataCompliant	boolean	When set to true, indicates that the project is compliant with Nuance's child data policy.
projectDescription	string	Project description.

mix.api.ProjectLock

mix.api.ProjectLock schema

{
  "lockId": "18",
  "projectId": "2960",
  "lockOwner": {
    "id": "36",
    "email": "alex.smith@company.com"
  },
  "notes": "Exporting model",
  "createTime": "2021-11-10T15:33:35Z"
}

Message that defines a project lock.

Properties

Name	Type	Description
lockId	string	ID of the lock instance.
projectId	string	ID of the locked project.
lockOwner	mix.api.User	User who created the lock.
notes	string	Lock notes.
createTime	string(date-time)	Date and time the lock was created.

mix.api.ProjectRequest

mix.api.ProjectRequest schema

{
  "displayName": "string",
  "languages": [
    "string"
  ],
  "languageTopic": "string",
  "channels": [
    {
      "displayName": "string",
      "modes": [
        "MODE_UNSPECIFIED"
      ],
      "color": "COLOR_UNSPECIFIED"
    }
  ],
  "projectDescription": "string",
  "isChildDataCompliant": "NO",
  "enginePackId": "string"
}

Message that defines the project to create.

Properties

Name	Type	Description
displayName	string	Name of the project.
languages	[string]	List of languages to include in the project.
languageTopic	string	Language topic for the project.
channels	[mix.api.ChannelRequest]	List of channels to include in the project.
projectDescription	string	Short description of the type of project you are creating as well as the type of end user data you will be collecting and to what purpose. This field is required when isChildDataCompliant is set to YES.
isChildDataCompliant	mix.api.YesNo	By setting this flag to true, you acknowledge that your project is not primarily directed to children under 16. This is required to deploy application configurations in the Nuance SaaS cloud.
enginePackId	string	An optional ID of an engine pack that this project should use. Refer to ListEnginePacks for getting an engine pack ID. Only available when the organization has this feature enabled.

mix.api.RegexEntity

mix.api.RegexEntity schema

{
  "id": "string",
  "name": "string",
  "anaphora": "ANAPHORA_NOT_SET",
  "pattern": "string",
  "dataSource": "string",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Entity type used for pattern matching.

Properties

Name	Type	Description
id	string	UUID of the entity.
name	string	Entity name.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
pattern	string	Regular expression pattern for this entity.
dataSource	string	Data source used for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.RegexEntityCreateRequest

mix.api.RegexEntityCreateRequest schema

{
  "name": "string",
  "pattern": "string",
  "anaphora": "ANAPHORA_NOT_SET",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Request object for creating a regex-based entity.

Properties

Name	Type	Description
name	string	Entity name.
pattern	string	Regular expression pattern for this entity.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.RegexEntityUpdateRequest

mix.api.RegexEntityUpdateRequest schema

{
  "pattern": "string",
  "locale": "string",
  "anaphora": "ANAPHORA_NOT_SET",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Request object for updating a regex-based entity.

Properties

Name	Type	Description
pattern	string	Regular expression pattern for this entity.
locale	string	Locale for this pattern.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.RelationalEntity

mix.api.RelationalEntity schema

{
  "id": "string",
  "name": "string",
  "isA": "string",
  "hasA": {
    "entities": [
      "string"
    ]
  },
  "anaphora": "ANAPHORA_NOT_SET",
  "dataSource": "string",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Entity type that represents a relationship to one or more other entities.

Properties

Name	Type	Description
id	string	UUID of the entity.
name	string	Entity name.
isA	string	Name of the entity that this entity has an isA relationship with.
hasA	mix.api.HasA	Names of the entities that this entity has a hasA relationship with.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
dataSource	string	Data source used for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.RelationalEntityCreateRequest

mix.api.RelationalEntityCreateRequest schema

{
  "name": "string",
  "isA": "string",
  "hasA": {
    "entities": [
      "string"
    ]
  },
  "anaphora": "ANAPHORA_NOT_SET",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Request object for creating a relational entity. At least one of isA or hasA must be specified.

Properties

Name	Type	Description
name	string	Entity name.
isA	string	Name of the entity that this entity has an isA relationship with.
hasA	mix.api.HasA	Names of the entities that this entity has a hasA relationship with.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.RelationalEntityUpdateRequest

mix.api.RelationalEntityUpdateRequest schema

{
  "isA": "string",
  "hasA": {
    "entities": [
      "string"
    ]
  },
  "anaphora": "ANAPHORA_NOT_SET",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Request object for updating a relational entity.

Properties

Name	Type	Description
isA	string	Name of the entity that this entity has an isA relationship with. Set to blank (that is, "") to clear.
hasA	mix.api.HasA	Names of the entities that this entity has a hasA relationship with.
anaphora	mix.api.AnaphoraType	If set, sets the referrer for this entity.
settings	mix.api.EntitySettings	Message that defines the settings for an entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.RenameEntityRequest.EntityName

mix.api.RenameEntityRequest.EntityName schema

{
  "newEntityName": "string"
}

Message that defines an entity name.

Properties

Name	Type	Description
newEntityName	string	New name for the entity.

mix.api.RenameEntityResponse

mix.api.RenameEntityResponse schema

{
  "entity": {
    "listEntity": {
      "id": "335134db-e2f1-48b5-8abe-6dd4c0c4f98c",
      "name": "COFFEE_FLAVORS",
      "isDynamic": false,
      "numLiterals": 0,
      "settings": {
        "isSensitive": true,
        "canonicalize": true
      },
      "dataType": "NOT_SET"
    }
  }
}

Response object for rename entity.

Properties

Name	Type	Description
entity	mix.api.EntityResponse	Response object for an entity. Only one of baseEntity, relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned.

mix.api.RenameIntentPayload

mix.api.RenameIntentPayload schema

{
  "newIntentName": "string"
}

Object that defines the new intent name.

Properties

Name	Type	Description
newIntentName	string	New intent name.

mix.api.RenameIntentResponse

mix.api.RenameIntentResponse schema

{
  "intent": {
    "id": "be567689-7948-45db-ae9a-8c18f5dc4634",
    "name": "PAY_COFFEE",
    "isInBaseOntology": false,
    "links": []
  }
}

Response object returned by the Rename intent request.

Properties

Name	Type	Description
intent	mix.api.IntentResponse	Intent details.

mix.api.RenameProjectChannelPayload

mix.api.RenameProjectChannelPayload schema

{
  "displayName": "Updated channel name"
}

Object used by the Rename project channel request and response.

Properties

Name	Type	Description
displayName	string	New project channel name.

mix.api.RenameProjectPayload

mix.api.RenameProjectPayload schema

{
  "displayName": "string"
}

Object used for rename project request / response.

Properties

Name	Type	Description
displayName	string	New project name.

mix.api.ReplaceRuleBasedGrammarsResponse

mix.api.ReplaceRuleBasedGrammarsResponse schema

{
  "entity": {
    "ruleBasedEntity": {
      "id": "ca863394-2cfb-422d-b593-b90dfdb653b8",
      "name": "DP_NUMBER",
      "localeBasedGrammars": {
        "en-US": "grammar.grxml"
      },
      "settings": {
        "isSensitive": false,
        "canonicalize": true
      }
    }
  }
}

Response object for replacing the grammar of a rule-based entity.

Properties

Name	Type	Description
entity	mix.api.EntityResponse	Response object for an entity. Only one of baseEntity, relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned.

mix.api.RequestModelsContent

mix.api.RequestModelsContent schema

{
  "asr": [
    {
      "buildLabel": "string",
      "locale": "string"
    }
  ],
  "nlu": [
    {
      "buildLabel": "string",
      "locale": "string"
    }
  ],
  "dialog": {
    "buildLabel": "string"
  }
}

Message that defines a list of build models passed in a request.

Properties

Name	Type	Description
asr	[mix.api.BaseRequestModelContent]	ASR models.
nlu	[mix.api.BaseRequestModelContent]	NLU models.
dialog	mix.api.DialogRequestModelContent	Dialog model.

mix.api.RuleBasedEntity

mix.api.RuleBasedEntity schema

{
  "id": "string",
  "name": "string",
  "anaphora": "ANAPHORA_NOT_SET",
  "localeBasedGrammars": {
    "property1": "string",
    "property2": "string"
  },
  "dataSource": "string",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Entity type used for recognizing a value based on a GrXML grammar file.

Properties

Name	Type	Description
id	string	UUID of the entity.
name	string	Entity name.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
localeBasedGrammars	object	Mapping of locales to grammar file names.
dataSource	string	Data source used for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.RuleBasedEntityCreateRequest

mix.api.RuleBasedEntityCreateRequest schema

{
  "name": "string",
  "anaphora": "ANAPHORA_NOT_SET",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Request object for creating a rule-based entity.

Properties

Name	Type	Description
name	string	Entity name.
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.RuleBasedEntityUpdateRequest

mix.api.RuleBasedEntityUpdateRequest schema

{
  "anaphora": "ANAPHORA_NOT_SET",
  "settings": {
    "isSensitive": true,
    "canonicalize": true
  },
  "dataType": "NOT_SET"
}

Request object for updating a rule-based entity.

Properties

Name	Type	Description
anaphora	mix.api.AnaphoraType	If set, specifies the referrer for this entity.
settings	mix.api.EntitySettings	Settings defined for this entity.
dataType	mix.api.DataType	Data type for the entity.

mix.api.TransferNode

mix.api.TransferNode schema

{
  "id": "string",
  "nodeName": "string",
  "nodeType": "TNT_TYPE_UNSPECIFIED",
  "description": "string",
  "requestVariables": [
    {
      "id": "string",
      "displayName": "string",
      "description": "string",
      "isReserved": true,
      "simpleVariableType": "VT_TYPE_UNSPECIFIED",
      "complexVariableTypeId": "string",
      "simpleGenericType": "VT_TYPE_UNSPECIFIED",
      "complexGenericTypeId": "string"
    }
  ]
}

Message that defines a transfer node.

Properties

Name	Type	Description
id	string	UUID of the node.
nodeName	string	Name of the node.
nodeType	mix.api.TransferNodeType	Type of the node.
description	string	Description of the node.
requestVariables	[mix.api.Variable]	List of variables to be returned by the client application.

mix.api.TransferNodeType

mix.api.TransferNodeType schema

"TNT_TYPE_UNSPECIFIED"

Enum that defines the type of transfer node.

• TNT_TYPE_UNSPECIFIED: Unspecified node
• END: End node
• ESCALATE: Escalate node
• CUSTOM: Custom node

mix.api.UndeployApplicationConfigResponse

mix.api.UndeployApplicationConfigResponse schema

{
  "undeployments": [
    {
      "configId": "2101",
      "applicationConfigDeploymentId": "1425",
      "environmentGeographyId": "37",
      "code": 0,
      "message": "App config undeployed."
    }
  ]
}

Response object returned by the Undeploy application configuration request.

Properties

Name	Type	Description
undeployments	[mix.api.ApplicationConfigUndeployment]	List of application configurations undeployed.

mix.api.UpdateChannelRequest

mix.api.UpdateChannelRequest schema

{
  "channelId": "string",
  "modes": [
    "MODE_UNSPECIFIED"
  ],
  "color": "COLOR_UNSPECIFIED"
}

Message that defines the channels to update.

Properties

Name	Type	Description
channelId	string	ID of the channel to update.
modes	[mix.api.Modality]	List of modalities to update for the channel.
color	mix.api.ChannelColor	Color of the channel.

mix.api.UpdateEntityResponse

mix.api.UpdateEntityResponse schema

{
  "entity": {
    "listEntity": {
      "id": "335134db-e2f1-48b5-8abe-6dd4c0c4f98c",
      "name": "COFFEE_TOPPINGS",
      "isDynamic": false,
      "numLiterals": 0,
      "settings": {
        "isSensitive": true,
        "canonicalize": true
      },
      "dataType": "NO_FORMAT"
    }
  }
}

Response object for update entity.

Properties

Name	Type	Description
entity	mix.api.EntityResponse	Response object for an entity. Only one of baseEntity, relationalEntity, listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned.

mix.api.UpdateProjectChannelResponse

mix.api.UpdateProjectChannelResponse schema

{
  "channel": {
    "id": "33849b2a-24f5-493e-b156-d91799d5186d",
    "displayName": "Custom channel",
    "codeName": "custom",
    "modes": [
      "INTERACTIVITY"
    ],
    "color": "SALMON"
  },
  "isActive": true
}

Response object returned by the Update project channel request.

Properties

Name	Type	Description
channel	mix.api.Channel	Deprecated. Project channel.
isActive	boolean	When set to true, indicates that the channel is active.
extendedChannel	mix.api.ExtendedChannel	Extended set of attributes about the project channel.

mix.api.User

mix.api.User schema

{
  "id": "string",
  "email": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "lastLoginTime": "2019-08-24T14:15:22Z",
  "name": "string"
}

Message that defines a user that is a member of an organization.

Properties

Name	Type	Description
id	string	Unique ID identifiying the member in the organization.
email	string	Email address of the user.
createTime	string(date-time)	Date and time the user was created.
lastLoginTime	string(date-time)	Date and time of the user's last login.
name	string	Name of the user.

mix.api.Variable

mix.api.Variable schema

{
  "id": "string",
  "displayName": "string",
  "description": "string",
  "isReserved": true,
  "simpleVariableType": "VT_TYPE_UNSPECIFIED",
  "complexVariableTypeId": "string",
  "simpleGenericType": "VT_TYPE_UNSPECIFIED",
  "complexGenericTypeId": "string"
}

Message that defines a variable.

Properties

Name	Type	Description
id	string	UUID of the variable.
displayName	string	Name of the variable.
description	string	Description of the variable.
isReserved	boolean	true for reserved variables; otherwise false.
simpleVariableType	mix.api.VariableType	Only present for defined simple variables; type of simple variable.
complexVariableTypeId	string	Only present for complex variables; UUID of the schema for this complex variable.
simpleGenericType	mix.api.VariableType	Only present for simple variables where simpleVariableType is LIST_TYPE; indicates the type of the items in the list.
complexGenericTypeId	string	Only present for simple variables where simpleVariableType is LIST_TYPE, and the list items are complex variables; UUID of the schema for the items in the list.

mix.api.VariableType

mix.api.VariableType schema

"VT_TYPE_UNSPECIFIED"

Enum that defines the type of simple variable; see Mix.dialog documentation for additional details.

• VT_TYPE_UNSPECIFIED: Unspecified type
• STRING_TYPE: String of characters
• BOOLEAN_TYPE: Boolean (true, false)
• LIST_TYPE: List of values of a single (simple or complex) variable type
• INTEGER_TYPE: Whole number
• DECIMAL_TYPE: Decimal-point number
• DATE_TYPE: Date (YYYYMMDD)
• TIME_TYPE: Time (HHMM)
• DYNAMIC_ENTITY_DATA: Special type, to support dynamic list entities
• DISTANCE_TYPE: Distance, including unit and modifier
• TEMPERATURE_TYPE: Temperature, including unit
• AMOUNT_TYPE: Amount, including currency
• DIGITS_TYPE: String of digits (0-9)
• ALPHANUM_TYPE: String of alphanumeric characters (a-z, A-Z, 0-9)

mix.api.Version

mix.api.Version schema

{
  "mixEnvironment": "us",
  "mixVersion": "3.5.10",
  "apiVersion": "0.9.4"
}

Response object returned by the Get Versions request.

Properties

Name	Type	Description
mixEnvironment	string	Mix environment.
mixVersion	string	Mix version.
apiVersion	string	Mix.api version.

mix.api.YesNo

mix.api.YesNo schema

"NO"

ENUM that defines yes / no values.

mix.api.v2.Application

mix.api.v2.Application schema

{
  "id": "string",
  "applicationName": "string",
  "organizationId": "string",
  "organizationName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "configs": [
    {
      "id": "string",
      "tag": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "deployments": [
        {
          "id": "string",
          "status": "STATUS_UNSPECIFIED",
          "createTime": "2019-08-24T14:15:22Z",
          "updateTime": "2019-08-24T14:15:22Z",
          "envGeographyDeployments": [
            {}
          ]
        }
      ],
      "parentId": "string",
      "deploymentFlowId": 0,
      "builds": {
        "asr": {
          "builds": [
            null
          ],
          "projectId": "string"
        },
        "nlu": {
          "builds": [
            null
          ],
          "projectId": "string"
        },
        "dialog": {
          "projectId": "string",
          "buildVersion": "string",
          "buildLabel": "string",
          "createTime": "2019-08-24T14:15:22Z"
        }
      },
      "projectDetails": {
        "projectId": "string",
        "projectName": "string",
        "isChildDataCompliant": true,
        "projectDescription": "string"
      }
    }
  ]
}

Message that defines a Mix application.

Properties

Name	Type	Description
id	string	Unique ID identifying the application.
applicationName	string	Name of the application.
organizationId	string	ID of the application's organization.
organizationName	string	Name of the application's organization.
createTime	string(date-time)	Date and time the application was created.
configs	[mix.api.ApplicationConfig]	List of application configurations.

mix.api.v2.ListApplicationsResponse

mix.api.v2.ListApplicationsResponse schema

{
  "applications": [
    {
      "id": "48",
      "applicationName": "Mix Sample App",
      "organizationId": "3",
      "organizationName": "json.smith@nuance.co.uk",
      "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.co.uk"
                  },
                  "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
}

Response object returned by the Get list of applications request.

Properties

Name	Type	Description
applications	[mix.api.v2.Application]	List of Mix applications.
count	integer(int32)	Total number of applications in the result.
totalSize	integer(int32)	Total number of applications that match the request, if applicable.
limit	integer(int32)	Value of limit field specified in request, if applicable.
offset	integer(int32)	Value of offset field specified in request, if applicable.

Change log

2022-10-26

Mix.api version: 0.9.59

• The following endpoints are now available to users with the Expert organization roles:
  • Export rule-based grammars
  • Replace rule-based grammars
• Added filter to Get list of Mix applications endpoint.

2022-10-05

Mix.api version: 0.9.56

• The mix.api.Organization message now includes whether deep learning model build, engine pack selection, or data pack selection is enabled for an organization.

2022-09-27

Mix.api version: 0.9.55

• The mix.api.NLUModelType values were renamed:
  • FAST is deprecated and was renamed LEGACY
  • ACCURATE is deprecated and was renamed DEEP_LEARNING

Mix.api version: 0.9.54

• Added new endpoints for data types:
  • GET /v4/data-types
  • GET /v4/ontology/entity-types
• Updated multiple endpoints and schemas to include data types.
• The Project object now returns the ID of the organization to which the project belongs.
• Added new job status type, STARTED.

2022-07-06

Mix.api version: 0.9.52

• The Get list of Mix projects request can now return the list of features supported by an engine pack.
• The Get Organizations list request can now also return the organizations that contain projects to which the user has access.

2022-05-17

Mix.api version: 0.9.50

• The extendedProject object now returns a list of ExtendedChannelTarget objects instead of ChannelTarget objects.
• The Create project channel request now returns the ExtendedChannel object instead of the Channel object.
• The Update project channel request now returns the new ExtendedChannel object instead of the Channel object.
• The following schemas were created:
  • ExtendedChannel
  • ExtendedChannelTarget
  • ExtendedModality
• The ApplicationConfigDeployment object now includes the deployment status code.

2022-04-13

Mix.api version: 0.9.46

• The extendedProject object now includes child data compliance policy details.

2022-04-05

Mix.api version: 0.9.45

• The extendedProject object now includes additional details:
  • Name of organization
  • Date and time that the latest ASR, NLU, and Dialog models were created
• The Get list of Mix projects and Get organization projects endpoints now provide the excludeChannels flag to exclude project channels from the response. This improves API performance.

2022-03-23

Mix.api version: 0.9.43

• Added new channel endpoints:
  • POST /v4/projects/{projectId}/channels
  • PUT /v4/projects/{projectId}/.channel
  • PUT /v4/projects/{projectId}/channels/{channelId}/.activate
  • PUT /v4/projects/{projectId}/channels/{channelId}/.deactivate
  • PUT /v4/projects/{projectId}/channels/{channelId}/.rename
• Added filter to Get Organizations list endpoint.
• Added approval data to the mix.api.EnvironmentGeographyAppConfigDeployment schema.
• Added more information to indicate that project details are based on the last builds created for the application configuration.

2022-02-16

Mix.api version: 0.9.41

• Added new project endpoint to get list of Mix projects for all organizations. This endpoint returns an extended set of attributes for each project.
• Added default values used for pagination.

2022-02-02

Mix.api version: 0.9.40

• The application configuration schema now includes project details. See Get application configuration for an example.
• The EnvironmentGeographyAppConfigDeployment schema now includes additional information about a deployment: user who requested the deployment, user who approved it, and list of data hosts.
• The environment geography schema now includes the environment name.
• The message that defines an organization member now includes the user name.
• The Get organizations endpoint now supports pagination.

2021-12-15

Mix.api version: 0.9.35

• Added organization ID and name to the Get /v4/apps endpoint response.
• The sort query parameter was replaced by sortBy for the following endpoints:
  • GET /v4​/projects​/{projectId}​/jobs
  • GET /v4/organizations/{orgId}/environments
  • GET /v4/organizations/{orgId}/deployment-flows
  • GET /v4/projects/{projectId}/builds
  • GET /v4/geographies
  • GET /v4/projects/.locks

2021-11-24

Mix.api version: 0.9.28

• Added new entity endpoints:
  • GET /v4/project/{projectId}/entities/
  • POST /v4/project/{projectId}/entities/
  • GET /v4/project/{projectId}/entities/
  • DELETE /v4/project/{projectId}/entities/
  • PUT /v4/project/{projectId}/entities/
  • PUT ​/v4​/projects​/{projectId}​/entities​/{entityName}​/.rename
  • PUT ​/v4​/projects​/{projectId}​/entities​/{entityName}​/.type
• Added a new application endpoint:
  • GET /v4/apps
• Added new endpoints for locking projects:
  • GET ​/v4​/projects​/{projectId}​/.lock
  • DELETE ​/v4​/projects​/{projectId}​/.lock
  • PUT ​/v4​/projects​/{projectId}​/.lock
  • GET ​/v4​/projects​/.locks
• Added new engine pack endpoint
  • GET ​/v4​/organizations​/{orgId}​/engine-packs
• A new field, enginePackId, was added to the added to the body of the Create a new project endpoint.
• Added channel colors and hex code to the mix.api.ChannelColor property

2021-11-03

Mix.api version: 0.9.27

• The isCoppaCompliant field, which is part of the body when creating a new project, has been renamed to isChildDataCompliant. isCoppaCompliant is now deprecated. Please update your applications to use the new field name. See Create a new project.
• Added new intent endpoints:
  • GET /v4/projects/{projectId}/intents
  • POST ​/v4​/projects​/{projectId}​/intents
  • GET ​/v4​/projects​/{projectId}​/intents​/{intentName}
  • DELETE ​/v4​/projects​/{projectId}​/intents​/{intentName}
  • PUT ​/v4​/projects​/{projectId}​/intents​/{intentName}​/.rename
• The Get build response now includes a new optional field, parentNLUBuildLabel.

2021-10-06

Mix.api version: 0.9.24

• Added section on obtaining a service account.

2021-09-29

Mix.api version: 0.9.24

• Added additional information about job status type, TIMED_OUT.

2021-09-8

Mix.api version: 0.9.21

• Nuance’s Child Data Policy prohibits providing hosted services to websites or online services that are primarily directed towards children under the age of 16. Two new fields, isChildDataCompliant and projectDescription, were added to the body of the Create a new project endpoint to support this feature.

• Added a new view option to the Get list of bots and Get list of Mix applications endpoints to only return the configurations that are deployed.
• Added a new flag, liveOnly, to the Get list of bot configurations and Get list of Mix application configurations endpoints to only return the configurations that are deployed.

2021-06-30

Mix.api version: 0.9.17

• Added build label to the Get latest builds endpoint
• The channel codeName is now returned correctly in the Get organization projects endpoint

2021-06-22

Mix.api version: 0.9.16

• Added list of builds to the application configuration schema.
• The Get list of application configurations and Get list of bot configurations endpoint now include a new flag, excludeOverrides, to exclude from the list the configurations that have been overridden.
• Added the code name of the channel to the channel schema; this name is used to specify the channel in the DLGaaS API.
• Breaking change: In the mix.api.ApplicationConfigContent schema, which is used to create a new application configuration, the models parameter was renamed to builds.

2021-06-11

Mix.api version: 0.9.15

• Added new project endpoints:
  • PUT /v4/projects/{projectId}/.datapack
  • GET /v4/projects/{projectId}/.export
  • POST /v4/projects/{projectId}/.replace
  • GET /v4/projects/{projectId}/metadata/.export
• Added new ontology endpoints:
  • GET /v4/projects/{projectId}/ontology/.export
  • PUT /v4/projects/{projectId}/ontology/.append
• Added new samples endpoints:
  • GET /v4/projects/{projectId}/intents/{intentName}/samples/.export
  • PUT /v4/projects/{projectId}/intents/{intentName}/samples/.append
  • POST /v4/projects/{projectId}/intents/{intentName}/samples/.replace
• Added new entities endpoints:
  • GET /v4/projects/{projectId}/entities/{entityName}/entity-literals/.export
  • PUT /v4/projects/{projectId}/entities/{entityName}/entity-literals/.append
  • POST /v4/projects/{projectId}/entities/{entityName}/entity-literals/.replace
• Added new data hosts endpoint:
  • GET /v4/builds/{buildLabel}/data-hosts
• Updated [jobs endpoints]:
  • The job response now includes a new field, duration.
  • The job report now includes additional report types.

2021-04-28

Mix.api version: 0.9.14

• Added new application configuration endpoints:
  • GET /v4/organizations/{orgId}/apps
  • GET /v4/apps/{applicationId}/app-configs
  • POST /v4/apps/{applicationId}/app-configs
  • GET /v4/apps/{applicationId}/credentials
  • GET /v4/app-configs/{configId}
  • DELETE /v4/app-configs/{configId}
  • POST /v4/app-configs/{configId}/.override
  • GET /v4/app-configs/{configId}/.download
  • PUT /v4/app-configs/{configId}/.deploy
  • PUT /v4/app-configs/{configId}/.undeploy
  • GET /v4/apps/{applicationId}/projects/{projectId}/data-hosts/.latest
• Added a new builds endpoint:
  • GET /v4/projects/{projectId}/builds/.latest

2021-04-14

Mix.api version: 0.9.13

• Added new build endpoints:
  • POST /v4/projects/{projectId}/.build
  • GET /v4/projects/{projectId}/builds
  • GET /v4/builds/{buildLabel}
  • DELETE /v4/builds/{buildLabel}
  • GET /v4/builds/{buildLabel}/.download
• Added new job endpoints:
  • GET /v4/projects/{projectId}/jobs/{jobId}
  • DELETE /v4/projects/{projectId}/jobs/{jobId}
  • GET /v4/projects/{projectId}/jobs

2021-03-05

Mix.api version: 0.9.12

• Added new project endpoints:
  • GET /v4/organizations/{orgId}/projects
  • POST /v4/organizations/{orgId}/projects
  • GET /v4/projects/{project-id}
  • DELETE /v4/projects/{project-id}
  • PUT /v4/projects/{project-id}/.rename

2021-03-02

Mix.api version: 0.9.11

• Added a new endpoint:
  • GET /v4/organizations/{orgId}/language-topics
• You can now specify your service credentials directly in the Swagger documentation to call the endpoints. See Specify service credentials for details.

2021-02-17

Mix.api version: 0.9.10

• Added two new endpoints:
  • GET /v4/geographies
  • GET /v4/organizations/{orgId}/deployment-flows
• Bot Configs are now linked to a deployment flow through an ID.
• The GET /v4/organizations endpoint now returns only the organizations that the user is part of. A new input parameter, show_all, can be used to return all organizations. Note that this parameter requires specific permissions.
• Breaking change: Site was renamed to geography.

2021-02-09

Mix.api version: 0.9.9

• The EnvironmentGeography object now includes the root host information to use for runtime requests.
• Fixed permission handling for the bot config interface.

2021-02-01

Mix.api version: 0.9.8

First release of this document.