LogoLogo
  • GETTING STARTED
    • Welcome to the NLX platform
    • How NLX works
    • Guides
      • Analytics dashboard
      • Chat
      • Generative Journey (Slots)
      • Model Context Protocol
      • Voice
      • Voice+ script
      • Touchpoint components
        • Carousel modality
        • Video modality
    • Terms & concepts
    • Generative AI
    • Developer
  • Build
    • Workspace setup
    • Flows
      • Intro to flows & variables
      • The Canvas
      • Flow settings
      • Nodes
      • Flow appearance
    • Resources
      • Actions
        • Implementation
        • Request model
      • Analytics tags
      • Context variables
      • Data requests
        • Implementation
        • Response model
        • Request model
      • Knowledge bases
        • Ingest content
        • Add metadata (beta)
        • Apply KB
      • Lifecycle hooks
        • Implementation
      • Modalities
      • Secrets
      • Slots (custom)
        • Adding values
        • Translating slots
      • Voice+ scripts
        • Add + download script
        • Deploy script + install SDK
        • Create Voice+ flow
    • Integrations
      • Channels
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Bandwidth
        • Genesys
        • Twilio
        • Zendesk Sunshine
      • LLM services
        • Amazon Bedrock
        • Anthropic
        • Azure OpenAI
        • Cerebras
        • Cohere
        • Google Vertex AI
        • Groq
        • NVIDIA
        • OpenAI
        • xAI
      • NLP
        • Amazon Lex
        • Google Dialogflow
        • Google Dialogflow CX
        • Custom NLP
    • Translations
  • Deploy & test
    • Applications
      • Attach flows
      • Assign default behavior
      • Add channels
        • API
          • REST API
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Genesys
        • Genesys SMS
        • Messenger
        • Microsoft Teams
        • Slack
        • SMS via Bandwidth
        • Twilio SMS
        • Twilio Voice
        • WhatsApp via Twilio
        • Zendesk Sunshine
      • Deploy
      • Optional: Set lifecycle
      • Optional: Set languages
    • Test
      • Test a conversation
      • Automated tests
      • Test an external integration
  • Analyze
    • Conversations
    • Analytics
      • Creating dashboards
      • Formulas & multi-metrics
      • Canvas analytics
    • Training
  • Workspace Settings
    • Escalation channels
    • Resource tags
    • Audit
  • Admin
    • Access control
      • Roles & permissions
    • Notifications
    • FAQ
    • Contact support
Powered by GitBook
On this page
  • Create API channel
  • Touchpoint SDK configurator
  1. Deploy & test
  2. Applications
  3. Add channels

API

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

Last updated 16 days ago

Create API channel

  • 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


Touchpoint SDK configurator

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.

application build and deploy
Whitelisted domains section
MCP guide
Developer docs
SDK
MCP enabled
AI description