Swagger documentation

You can access the Mix.api endpoints directly from the Swagger documentation, available at one of the following URLs, based on your geography:

Geography URL
Australia https://mix.api.nuance.net.au/v4/swagger-ui/index.html 
EU https://mix.api.nuance.eu/v4/swagger-ui/index.html 
UK https://mix.api.nuance.co.uk/v4/swagger-ui/index.html 
US https://mix.api.nuance.com/v4/swagger-ui/index.html 

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

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:
  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:
    Mix.dialog nodes
  5. Click Authorize.
  6. Click Close.

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