Runtime APIs: Quick Reference

This topic summarizes the main resources for using the gRPC APIs to interact with the automatic speech recognition (ASR), Nuance Recognizer (NR), natural language understanding (NLU), Dialog, and text-to-speech (TTS) runtime services.

API versions and proto files

API versions with links to documentation and proto file downloads
Service API Current version Proto files Documentation
ASRaaS Recognizer v1 Download gRPC setup
Training Download
ForgetMe Download
NLUaaS Runtime v1 Download gRPC setup
Wordset Download
DLGaaS DialogService v1 Download gRPC setup
TTSaaS Synthesizer and Storage v1 Download gRPC setup
Neural TTSaaS Synthesizer v1 Download gRPC setup
NRaaS Nuance Recognizer v1 Download gRPC setup

gRPC-web support

This table lists the Nuance Mix runtime services that are gRPC-Web compliant.

Service gRPC-Web
ASRaaS ✓
NLUaaS ✓
DLGaaS
TTSaaS ✓
NRaaS

Service URLs

This section lists the service URLs for the United States geography.

See Geographies for details about the other Mix geographies.

Service Production URL
ASRaaS asr.api.nuance.com
ForgetMe asr.api.nuance.com
NLUaaS nlu.api.nuance.com
DLGaaS dlg.api.nuance.com
TTSaaS tts.api.nuance.com
Neural TTSaaS tts.api.nuance.com with header x-nuance-tts-neural
NRaaS nr.api.nuance.com
Event logs log.api.nuance.com
Mix.api mix.api.nuance.com/v4

Authorization URL

This section lists the authorization URL for the United States geography.

See Geographies for details about the other Mix geographies.

Server URL
Nuance OAuth server auth.crt.nuance.com

See Authorize your client application: Runtime for more information.

Authorization scopes

Service Scopes
ASRaaS asr: Provides access to the ASRaaS runtime API and resources
asr.wordset: Allows client applications to upload ASR wordsets
asr.forgetme: Allows client applications to remove speaker profiles
NLUaaS nlu: Provides access to the NLUaaS runtime API and resources
nlu.wordset: Allows client applications to upload NLU wordsets
DLGaaS dlg: Provides access to the DLGaaS runtime API and resources
TTSaaS tts: Provides access to the TTSaaS runtime API and resources
Neural TTSaaS tts: Provides access to the Neural TTSaaS runtime API and resources
NRaaS nr: Provides access to the NRaaS runtime API and resources
Event logs log: Provides access to event logs

See Authorize your client application: Runtime for more information.

Access token lifetime

The access token expires after 15 minutes so must be regenerated frequently.

Limits

For security reasons, Mix has rate limits and data limits. See Limits.

URN format

There are two types of URNs: URNs for resources, and URNs for wordsets.

Resource URNs

Mix.asr DLM, Mix.nlu model, and Mix.dialog resource URNs have this pattern:

urn:nuance-mix:tag:model/context_tag/service(?=language=language)

Where:

  • context_tag is the Context Tag specified when creating an application configuration, for example, A48_C643 or coffee_app.
  • service is one of mix.asr, mix.nlu, or mix.dialog.
  • language is the locale of the application configuration. For URNs, this is the 6-letter language code as documented in the Geographies section; for example, eng-USA. This applies to Mix.asr and Mix.nlu only.

For example, to load the resource for the American English coffee_app application configuration, specify the URN as follows:

Example URNs for resources
Service URN
Mix.asr urn:nuance-mix:tag:model/coffee_app/mix.asr?=language=eng-USA
Mix.nlu urn:nuance-mix:tag:model/coffee_app/mix.nlu?=language=eng-USA
Mix.dialog urn:nuance-mix:tag:model/coffee_app/mix.dialog

You can find the URN for an application configuration in the Credentials tab.

Wordset URNs

URNs for the ASR and NLU wordsets have one of the following patterns, depending on the level of the wordset:

  • Application-level wordset:

    urn:nuance-mix:tag:wordset:lang/context_tag/resource_name/language/service

  • User-level wordset:

    urn:nuance-mix:tag:wordset:lang/context_tag/resource_name/language/service?=user_id=userId

Where:

  • context_tag is the context tag name for this wordset. When you create the wordset, you can provide any context tag name. This name does not have to match the context tag of the companion Mix.asr DLM or Mix.nlu model.
  • resource_name is the name of the wordset.
  • service is one of mix.asr or mix.nlu.
  • language is the locale of the wordset. For URNs, this is the 6-letter language code as documented in the Geographies section; for example, eng-USA.
  • userID is the unique identifier for the user.

For example, to upload the Mix.asr cities_wordset application-level wordset, specify the URN as follows:

urn:nuance-mix:tag:wordset:lang/names-places/cities_wordset/eng-USA/mix.asr