API
Learn to set up an API communication channel for your application in your NLX workspace
Last updated
Learn to set up an API communication channel for your application in your NLX workspace
Last updated
Navigate to Channels tab of your application
Expand API option
Select + Create 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 (you may need to add variations of your domain with a trailing slash / and without)
MCP interface: Exposes a Model Context Protocol (MCP) interface for your API channel for all flows attached to the application that also have
Once turned on, provide an in the application's settings tab for the MCP Client to reference. Check out our complete for more information
Voice: Enables users to interact with your application using voice over your web-based channel. See for supporting with NLX Touchpoint
Click Create channel
We recommend using our official Touchpoint 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:
Select the Details link next to the build's Deployed status
Expand the API section of the modal
Click Open Touchpoint configurator
Create an
To use the chat widget configurator, be sure to add https://developers.nlx.ai to the of your API channel setup.