# Docs

## Home

- [Home](https://docs.nlx.ai/platform/readme.md): Welcome to your team’s developer platform

## Platform

- [Vision](https://docs.nlx.ai/platform/nlx-platform-guide/introduction-to-nlx/vision.md): Become acquainted with the next evolution of conversational AI
- [Platform](https://docs.nlx.ai/platform/nlx-platform-guide/introduction-to-nlx/platform.md): Create intelligent conversational applications with NLX
- [Overview](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/overview.md): Develop conversational AI applications with NLX
- [Setup](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/setup.md): Learn to set up your conversational AI application with NLX in minutes
- [Automated tests](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/setup/automated-tests.md): Set up and quickly test inputs or training data using Automated tests in NLX
- [Types](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/types.md): Become acquainted with the various AI apps you can create with NLX
- [Testing](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/testing.md): Test and experience a single workflow or full conversation in NLX
- [Deployment](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/deployment.md): Understand how NLX deployments work, from building and testing your AI app to choosing channels and publishing it live
- [Channels](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/deployment/managing-channels.md): Easily set up channels of communication for your application in your NLX workspace
- [API](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/deployment/managing-channels/creating-an-api-channel.md): Learn to set up an API communication channel for your application in your NLX workspace
- [REST API](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/deployment/managing-channels/creating-an-api-channel/rest-api.md): REST API documentation for NLX's API communication channel
- [Amazon Connect](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/deployment/managing-channels/creating-an-amazon-connect-channel.md): Learn to set up an Amazon Connect communication channel for your application in your NLX workspace
- [Hosting](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/deployment/hosting.md): Quickly host NLX apps on Touchpoint or a custom domain with secure setup.
- [MCP server](https://docs.nlx.ai/platform/nlx-platform-guide/ai-applications/deployment/mcp-server.md): From start to finish, set up an NLX application exposed through Model Context Protocol (MCP)
- [Overview](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/overview.md): Easily integrate third-party or custom connections in NLX
- [Types](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types.md): Explore the various types of external connections you can set up in your NLX workspace
- [NLP engines](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/nlp-engines.md): Effortlessly set up your Amazon Lex, Google Dialogflow, or custom NLP into your NLX workspace
- [Amazon Lex](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/nlp-engines/amazon-lex.md): Quickly set up the Amazon Lex NLP into your NLX workspace
- [Custom NLP](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/nlp-engines/custom-nlp.md): Quickly set up your custom NLP into your NLX workspace
- [LLM services](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/llm-services.md): Effortlessly set up Large Language Model service into your NLX workspace
- [Cerebras](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/llm-services/cerebras.md): Quickly set up the Cerebras LLM service into your NLX workspace
- [OpenAI](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/llm-services/openai.md): Quickly set up the OpenAI LLM service into your NLX workspace
- [Custom integrations](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/data-requests.md): Integrate custom APIs for injecting real-time data or actions in conversation
- [Managed integrations](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/managed-integrations.md): Effortlessly set up a managed API service in your NLX workspace
- [Google services](https://docs.nlx.ai/platform/nlx-platform-guide/integrations/types/managed-integrations/google-services.md): Quickly set up Google managed services in your NLX workspace
- [Overview](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview.md): Guide conversation flows & organize business actions using flows in your NLX workspace
- [Flows & variables](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/flows-and-variables.md): Learn about the components of flows and variables and how they operate in NLX
- [Turns & state](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/turns-and-state.md): Learn about the what defines a turn, memory state, and how to troubleshoot in NLX
- [Canvas](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/canvas.md): Learn to build powerful AI conversations using the Canvas in your NLX workspace
- [Flow settings](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/setup.md): Learn to easily configure settings of your intent and its flow in your NLX workspace
- [Nodes](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/nodes.md): Get acquainted with nodes that construct your conversation flows in NLX
- [Appearance](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/overview/stay-organized.md): Discover tools for keeping your flows organized in your NLX workspace
- [Knowledge bases](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/knowledge-bases.md): Tap into more information resources to assist your customers in your NLX workspace
- [Ingest content](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/knowledge-bases/ingest-content.md): Easily set up your knowledge base data in NLX
- [Add metadata](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/knowledge-bases/add-metadata.md): Easily apply metadata filters for retrieval requests to your knowledge base in NLX
- [Support citations](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/knowledge-bases/support-citations.md): Display in-line citations in chat using responses from your knowledge base
- [Use a KB](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/knowledge-bases/use-a-kb.md): Learn how to put your knowledge base to work in NLX
- [Modalities](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/modalities.md): Manage and set up advanced payloads with Modalities in NLX
- [Advanced](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced.md)
- [Generative Journey® (Slots)](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/generative-journey-r-slots.md): From start to finish, set up a flow using Generative Journey in slot capture mode with NLX
- [Actions](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/actions.md): Empower conversations with Actions—send content or perform tasks
- [Agentic Voice+](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/agentic-voice+.md): Create a bidirectional agent for multimodal voice-driven experiences using the NLX platform
- [Context variables](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/context-variables.md): Create custom context for values to use across intent flows in NLX
- [Escalation channels](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/escalation-channels.md): Learn how to set up escalation transfers in NLX
- [Lifecycle hooks](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/lifecycle-hooks.md): Trigger general actions at the start, end, or escalation point of your conversations
- [NLP training](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/nlp-training.md): Identify and quickly train unrecognized user inputs in your NLX workspace
- [Phone channel](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/phone-channel.md): From start to finish, set up an application for phone interfaces with NLX
- [Secrets](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/secrets.md): Manage and set up sensitive parameters for added security and efficiency in an NLX workspace
- [Slots (custom)](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/slots-custom.md): Provide choices and direct conversations more efficiently using custom slots with NLX
- [Translations](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/translations.md): Manage workspace languages & translations efficiently in your NLX workspace
- [Touchpoint modalities](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/touchpoint-modalities.md): A collection of walkthroughs to get you up and running with NLX Touchpoint features
- [Carousel modality](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/touchpoint-modalities/carousel-modality.md): From start to finish, provide a chat Carousel modality with NLX Touchpoint
- [Video modality](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/touchpoint-modalities/video-modality.md): From start to finish, set up a chat-based application ft. a custom video modality with NLX
- [Voice+ scripts](https://docs.nlx.ai/platform/nlx-platform-guide/flows-and-building-blocks/advanced/voice+-scripts.md): Create structured voice-guided prompts for your web assets in the NLX platform
- [Analytics](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/analytics.md): Easily track conversation performance and the metrics that matter with NLX
- [Creating dashboards](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/analytics/creating-dashboards.md): Learn to construct powerful data visualizers for monitoring key metrics in your NLX workspace
- [Formulas & multi-metrics](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/analytics/formulas-and-multi-metrics.md): Learn to apply calculated metrics to analytics dashboards in your NLX workspace
- [Canvas analytics](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/analytics/canvas-analytics.md): Quickly analyze usage of your conversation flow in in NLX
- [Analytics tags](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/analytics/analytics-tags.md): Define custom tags in your workspace to track performance of conversations in your NLX workspace
- [User feedback](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/user-feedback.md): Collect user feedback on AI replies easily with the NLX platform
- [Conversation history](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/conversation-history.md): Review past conversation history between users and applications in your NLX workspace
- [Alerts & notifications](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/alerts-and-notifications.md): Review notifications and setup alert subscriptions in your NLX workspace
- [Resource tags](https://docs.nlx.ai/platform/nlx-platform-guide/monitoring/resource-tags.md): Define custom tags in your workspace to better organize resources in your NLX workspace
- [Security](https://docs.nlx.ai/platform/nlx-platform-guide/governance/security.md): Learn how to protect your NLX workspace and ensure your apps are compliant and secure
- [Roles & permissions](https://docs.nlx.ai/platform/nlx-platform-guide/governance/roles-and-permissions.md): Manage user roles and permissions with your NLX account and workspaces
- [Versioning](https://docs.nlx.ai/platform/nlx-platform-guide/governance/versioning.md): Versioning in NLX stores historical snapshots of flows, apps, and integrations so you can review changes, compare versions, and safely restore past configurations
- [Audit trail](https://docs.nlx.ai/platform/nlx-platform-guide/governance/audit-trail.md): Track every event in your NLX workspace with Audit logs for governance, troubleshooting, and compliance.
- [Guardrails](https://docs.nlx.ai/platform/nlx-platform-guide/governance/guardrails.md): Define guardrails to control AI behavior, validate inputs and outputs, and enforce policy across conversational applications
- [Support](https://docs.nlx.ai/platform/nlx-platform-guide/resources/support.md): Access the Support Team for issues, inquiries, or requests about the NLX platform
- [FAQ](https://docs.nlx.ai/platform/nlx-platform-guide/resources/faq.md): Frequently asked questions related to NLX

## Developers

- [Developers Home](https://docs.nlx.ai/platform/developers/developers.md): Welcome to your team’s developer platform
- [Touchpoint](https://docs.nlx.ai/platform/developers/conversation-sdk/touchpoint.md): Touchpoint is a drop-in conversational UI and SDK with support for chat, voice, and Voice+™ interactions.
- [Setup](https://docs.nlx.ai/platform/developers/conversation-sdk/setup.md)
- [Web](https://docs.nlx.ai/platform/developers/conversation-sdk/setup/web.md): This page documents the @nlxai/touchpoint-ui package, serving as the guide for the Touchpoint SDK for web applications.
- [iOS](https://docs.nlx.ai/platform/developers/conversation-sdk/setup/ios.md): Documents the Touchpoint iOS package, serving as the guide for the Touchpoint SDK for iOS applications.
- [Android](https://docs.nlx.ai/platform/developers/conversation-sdk/setup/android.md): This page documents the Touchpoint Android package, serving as the guide for the Touchpoint SDK for Android applications.
- [Examples](https://docs.nlx.ai/platform/developers/conversation-sdk/examples.md): Example usage of Touchpoint, NLX's Conversation SDK.
- [Chat](https://docs.nlx.ai/platform/developers/conversation-sdk/examples/chat.md): Learn how to set up a textual chat application
- [Voice](https://docs.nlx.ai/platform/developers/conversation-sdk/examples/voice.md): Example set up of a voice application
- [Voice+™](https://docs.nlx.ai/platform/developers/conversation-sdk/examples/voice+-tm.md): Set up a voice assistant for your website or web app
- [Advanced](https://docs.nlx.ai/platform/developers/conversation-sdk/examples/advanced.md)
- [Embedded mode](https://docs.nlx.ai/platform/developers/conversation-sdk/examples/advanced/embedded-mode.md): Use Touchpoint inside your layout
- [Modalities](https://docs.nlx.ai/platform/developers/conversation-sdk/examples/advanced/modalities.md): Implement custom modalities
- [Theming](https://docs.nlx.ai/platform/developers/conversation-sdk/examples/advanced/theming.md)
- [Voice+™ over the phone](https://docs.nlx.ai/platform/developers/conversation-sdk/examples/advanced/voice+-tm-over-the-phone.md): Use Touchpoint Voice+ with an external telephony channel
- [Overview](https://docs.nlx.ai/platform/developers/conversation-api/overview.md)
- [REST](https://docs.nlx.ai/platform/developers/conversation-api/rest.md)
- [Conversation](https://docs.nlx.ai/platform/developers/conversation-api/rest/conversation.md)
- [Context](https://docs.nlx.ai/platform/developers/conversation-api/rest/context.md)
- [Models](https://docs.nlx.ai/platform/developers/conversation-api/rest/models.md)
- [Streamable HTTP](https://docs.nlx.ai/platform/developers/conversation-api/streamable-http.md)
- [Conversation](https://docs.nlx.ai/platform/developers/conversation-api/streamable-http/conversation.md)
- [Models](https://docs.nlx.ai/platform/developers/conversation-api/streamable-http/models.md)
- [Websocket](https://docs.nlx.ai/platform/developers/conversation-api/websocket.md)
- [Async API spec](https://docs.nlx.ai/platform/developers/conversation-api/websocket/async-api-spec.md)
- [OpenAI](https://docs.nlx.ai/platform/developers/conversation-api/openai.md)
- [Chat](https://docs.nlx.ai/platform/developers/conversation-api/openai/chat.md)
- [Models](https://docs.nlx.ai/platform/developers/conversation-api/openai/models.md)
- [MCP](https://docs.nlx.ai/platform/developers/conversation-api/mcp.md)
- [MCP](https://docs.nlx.ai/platform/developers/conversation-api/mcp/mcp.md)
- [Models](https://docs.nlx.ai/platform/developers/conversation-api/mcp/models.md)
- [Overview](https://docs.nlx.ai/platform/developers/voice+-api/overview.md)
- [Context](https://docs.nlx.ai/platform/developers/voice+-api/context.md)
- [Track](https://docs.nlx.ai/platform/developers/voice+-api/track.md)
- [SDK](https://docs.nlx.ai/platform/developers/voice+-api/track/sdk.md)
- [Conversation](https://docs.nlx.ai/platform/developers/voice+-api/track/conversation.md)
- [Context](https://docs.nlx.ai/platform/developers/voice+-api/track/context.md)
- [Models](https://docs.nlx.ai/platform/developers/voice+-api/track/models.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.nlx.ai/platform/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.