API

Learn to set up an API communication channel for your application in your NLX workspace

All newly-created applications automatically include a default API channel set up.

Access API channel

  • Select Configuration tab of your application

  • Under Delivery section, choose the three-dots menu beside the API channel

  • Select Edit channel

Optional:

  • API key: Matched against the HTTP headers from the conversational AI application

  • Whitelisted domains: Domains authorized to make CORS calls to the API channel. Supports both exact string matches and regex patterns:

    • Exact: https://example.com

    • Regex: ^https:\\/\\/[a-z0-9\\-_]+\\.herokuapp\\.com\\/?$

      • Regex patterns must start with ^ and end with $

  • MCP interface: Exposes a Model Context Protocol (MCP) interface for your API channel for all flows attached to the application that also have MCP enabled

    • Once turned on, provide an AI description in the application's settings tab for the MCP Client to reference. Check out our complete MCP guide for more information

  • Voice: ON by default for new applications. Equips your application with voice capabilities and allows your users to converse with your AI application through their microphone/speaker setup. See list of languages supported

    • TTS provider: Choose from the built-in options (Inworld AI, ElevenLabs, Hume, OpenAI, or Amazon Polly). If you’d like to use your own Inworld instance, first create an integration, then select it from the dropdown

    • Voice: When Voice is enabled, choose from a selection of voice personas for your AI application based on the TTS provider. To hear how Inworld personas sound, try out their preview generator

    • Interruptible: If enabled, permits users to interrupt the AI application when it's speaking

Install Touchpoint

We recommend using our official Touchpoint SDK to set up communication with API channels from within a web frontend. This contains:

  • A vanilla JavaScript function for connecting to your application, maintaining a conversation, and subscribing to new messages

  • Our React hook to operate inside a React app without providing styling

  • A fully-styled, chat widget that is customizable to fit your style guide

To access the configurator:

  • Create an application build and deploy

  • Select the deployed build

  • Choose the Deployment tab of the modal and expand the API under Setup instructions

  • Click Open Touchpoint configurator

Last updated