# ASAPP Docs

## Docs

- [Agent Desk](https://docs.asapp.com/agent-desk.md): Use the Agent Desk to empower agents to deliver fast and exceptional customer service.
- [Digital Agent Desk](https://docs.asapp.com/agent-desk/digital-agent-desk.md): Use the Digital Agent Desk to empower agents to deliver fast and exceptional customer service.
- [Digital Agent Desk Navigation](https://docs.asapp.com/agent-desk/digital-agent-desk/agent-desk-navigation.md): Overview of the Digital Agent Desk navigation and features.
- [Agent SSO](https://docs.asapp.com/agent-desk/digital-agent-desk/agent-sso.md): Learn how to use Single Sign-On (SSO) to authenticate agents and admin users to the Digital Agent Desk.
- [API Integration](https://docs.asapp.com/agent-desk/digital-agent-desk/api-integration.md): Learn how to connect the Digital Agent Desk to your backend systems.
- [Knowledge Base](https://docs.asapp.com/agent-desk/digital-agent-desk/knowledge-base.md): Learn how to integrate your Knowledge Base with the Digital Agent Desk.
- [Live Agent Summary - GenAgent](https://docs.asapp.com/agent-desk/digital-agent-desk/live-agent-summary.md): Learn how to receive summaries from GenerativeAgent conversations.
- [Queues and Routing](https://docs.asapp.com/agent-desk/digital-agent-desk/queues-and-routing.md): Learn how to manage conversation queues and agent routing in the Digital Agent Desk.
- [Attributes Based Routing](https://docs.asapp.com/agent-desk/digital-agent-desk/queues-and-routing/attributes-based-routing.md): Learn how to use Attributes Based Routing (ABR) to route chats to the appropriate agent queue.
- [User Management](https://docs.asapp.com/agent-desk/digital-agent-desk/user-management.md): Learn how to manage users and roles in the Digital Agent Desk.
- [Insights Manager Overview](https://docs.asapp.com/agent-desk/insights-manager.md): Analyze metrics, investigate interactions, and uncover insights for data-driven decisions with Insights Manager.
- [Live Insights Overview](https://docs.asapp.com/agent-desk/insights-manager/live-insights.md): Learn how to use Live Insights to monitor and analyze real-time contact center activity.
- [Agent Performance](https://docs.asapp.com/agent-desk/insights-manager/live-insights/agent-performance.md): Monitor agent performance in Live Insights.
- [Alerts, Signals & Mitigation](https://docs.asapp.com/agent-desk/insights-manager/live-insights/alerts,-signals---mitigation.md): Use alerts, signals, and mitigation measures to improve agent task efficiency.
- [Customer Feedback](https://docs.asapp.com/agent-desk/insights-manager/live-insights/customer-feedback.md): Learn how to view customer feedback in Live Insights.
- [Live Conversations Data](https://docs.asapp.com/agent-desk/insights-manager/live-insights/live-conversations-data.md): Learn how to view and interact with live conversations in Live Insights.
- [Metric Definitions](https://docs.asapp.com/agent-desk/insights-manager/live-insights/metric-definitions.md): Learn about the metrics available in Live Insights.
- [Navigation](https://docs.asapp.com/agent-desk/insights-manager/live-insights/navigation.md): Learn how to navigate the Live Insights interface.
- [Performance Data](https://docs.asapp.com/agent-desk/insights-manager/live-insights/performance-data.md): Learn how to view performance data in Live Insights.
- [Queue Overview (All Queues)](https://docs.asapp.com/agent-desk/insights-manager/live-insights/queue-overview--all-queues-.md): Learn how to view and customize the performance overview for all queues and queue groups.
- [Integration Channels](https://docs.asapp.com/agent-desk/integrations.md): Learn about the channels and integrations available for ASAPP Messaging.
- [Android SDK Overview](https://docs.asapp.com/agent-desk/integrations/android-sdk.md): Learn how to integrate the ASAPP Android SDK into your application.
- [Android SDK Release Notes](https://docs.asapp.com/agent-desk/integrations/android-sdk/android-sdk-release-notes.md)
- [Customization](https://docs.asapp.com/agent-desk/integrations/android-sdk/customization.md)
- [Deep Links and Web Links](https://docs.asapp.com/agent-desk/integrations/android-sdk/deep-links-and-web-links.md)
- [Miscellaneous APIs](https://docs.asapp.com/agent-desk/integrations/android-sdk/miscellaneous-apis.md)
- [Notifications](https://docs.asapp.com/agent-desk/integrations/android-sdk/notifications.md)
- [User Authentication](https://docs.asapp.com/agent-desk/integrations/android-sdk/user-authentication.md)
- [Apple Messages for Business](https://docs.asapp.com/agent-desk/integrations/apple-messages-for-business.md)
- [Chat Instead Overview](https://docs.asapp.com/agent-desk/integrations/chat-instead.md)
- [Android](https://docs.asapp.com/agent-desk/integrations/chat-instead/android.md)
- [iOS](https://docs.asapp.com/agent-desk/integrations/chat-instead/ios.md)
- [Web](https://docs.asapp.com/agent-desk/integrations/chat-instead/web.md)
- [Customer Authentication](https://docs.asapp.com/agent-desk/integrations/customer-authentication.md)
- [iOS SDK Overview](https://docs.asapp.com/agent-desk/integrations/ios-sdk.md)
- [Customization](https://docs.asapp.com/agent-desk/integrations/ios-sdk/customization.md)
- [Deep Links and Web Links](https://docs.asapp.com/agent-desk/integrations/ios-sdk/deep-links-and-web-links.md)
- [iOS Quick Start](https://docs.asapp.com/agent-desk/integrations/ios-sdk/ios-quick-start.md)
- [iOS SDK Release Notes](https://docs.asapp.com/agent-desk/integrations/ios-sdk/ios-sdk-release-notes.md)
- [Miscellaneous APIs](https://docs.asapp.com/agent-desk/integrations/ios-sdk/miscellaneous-apis.md)
- [Push Notifications](https://docs.asapp.com/agent-desk/integrations/ios-sdk/push-notifications.md)
- [User Authentication](https://docs.asapp.com/agent-desk/integrations/ios-sdk/user-authentication.md)
- [Push Notifications and the Mobile SDKs](https://docs.asapp.com/agent-desk/integrations/push-notifications-and-the-mobile-sdks.md)
- [User Management](https://docs.asapp.com/agent-desk/integrations/user-management.md)
- [Voice](https://docs.asapp.com/agent-desk/integrations/voice.md)
- [Web SDK Overview](https://docs.asapp.com/agent-desk/integrations/web-sdk.md)
- [Web App Settings](https://docs.asapp.com/agent-desk/integrations/web-sdk/web-app-settings.md)
- [Web Authentication](https://docs.asapp.com/agent-desk/integrations/web-sdk/web-authentication.md)
- [Web ContextProvider](https://docs.asapp.com/agent-desk/integrations/web-sdk/web-contextprovider.md)
- [Web Customization](https://docs.asapp.com/agent-desk/integrations/web-sdk/web-customization.md)
- [Web Examples](https://docs.asapp.com/agent-desk/integrations/web-sdk/web-examples.md)
- [Web Features](https://docs.asapp.com/agent-desk/integrations/web-sdk/web-features.md)
- [Web JavaScript API](https://docs.asapp.com/agent-desk/integrations/web-sdk/web-javascript-api.md)
- [Web Quick Start](https://docs.asapp.com/agent-desk/integrations/web-sdk/web-quick-start.md)
- [WhatsApp Business](https://docs.asapp.com/agent-desk/integrations/whatsapp-business.md)
- [Virtual Agent](https://docs.asapp.com/agent-desk/virtual-agent.md): Learn how to use Virtual Agent to automate your customer interactions.
- [Attributes](https://docs.asapp.com/agent-desk/virtual-agent/attributes.md)
- [Best Practices](https://docs.asapp.com/agent-desk/virtual-agent/best-practices.md)
- [Flows](https://docs.asapp.com/agent-desk/virtual-agent/flows.md): Learn how to build flows to define how the virtual agent interacts with the customer.
- [Glossary](https://docs.asapp.com/agent-desk/virtual-agent/glossary.md)
- [Intent Routing](https://docs.asapp.com/agent-desk/virtual-agent/intent-routing.md): Learn how to route intents to flows or agents.
- [Links](https://docs.asapp.com/agent-desk/virtual-agent/links.md): Learn how to manage external links and URLs that direct customers to web pages.
- [Surveys](https://docs.asapp.com/agent-desk/virtual-agent/surveys.md): Collect customer satisfaction feedback after interactions with agents and AI systems.
- [AI Compose](https://docs.asapp.com/ai-productivity/ai-compose.md)
- [AI Compose Tooling Guide](https://docs.asapp.com/ai-productivity/ai-compose/ai-compose-tooling-guide.md): Learn how to use the AI Compose tooling UI
- [Deploying AI Compose API](https://docs.asapp.com/ai-productivity/ai-compose/deploying-ai-compose-api.md): Communicate with AI Compose via API.
- [Deploying AI Compose for LivePerson](https://docs.asapp.com/ai-productivity/ai-compose/deploying-ai-compose-for-liveperson.md): Use AI Compose on your LivePerson application.
- [Deploying AI Compose for Salesforce](https://docs.asapp.com/ai-productivity/ai-compose/deploying-ai-compose-for-salesforce.md): Use AI Compose on Salesforce Lightning Experience.
- [AI Compose Product Guide](https://docs.asapp.com/ai-productivity/ai-compose/product-guide.md): Learn more about the features and insights of AI Compose
- [AI Summary](https://docs.asapp.com/ai-productivity/ai-summary.md): Use AI Summary to extract insights and data from your conversations
- [Example Use Cases](https://docs.asapp.com/ai-productivity/ai-summary/example-use-cases.md): See examples of how AI Summary can be used
- [Free Text Summary](https://docs.asapp.com/ai-productivity/ai-summary/free-text-summary.md): Generate conversation summaries with Free Text Summary
- [Getting Started](https://docs.asapp.com/ai-productivity/ai-summary/getting-started.md): Learn how to get started with AI Summary
- [Intent](https://docs.asapp.com/ai-productivity/ai-summary/intent.md): Generate intents from your conversations
- [Metadata-Based Summary Routing](https://docs.asapp.com/ai-productivity/ai-summary/metadata-routing.md): Dynamically route AI Summary configurations based on conversation metadata attributes.
- [Deploying AI Summary for Salesforce](https://docs.asapp.com/ai-productivity/ai-summary/salesforce-plugin.md): Learn how to use the AI Summary Salesforce plugin.
- [AI Summary Sandbox](https://docs.asapp.com/ai-productivity/ai-summary/sandbox.md): Learn how to use the AI Summary Sandbox to test and validate summary generation.
- [Structured Data](https://docs.asapp.com/ai-productivity/ai-summary/structured-data.md): Extract entities and targeted data from your conversations
- [Segments and Customization](https://docs.asapp.com/ai-productivity/ai-summary/structured-data/segments-and-customization.md): Learn how to customize the data extracted with Structured Data.
- [AI Transcribe](https://docs.asapp.com/ai-productivity/ai-transcribe.md): Transcribe your audio with best in class accuracy
- [Deploying AI Transcribe for Amazon Connect](https://docs.asapp.com/ai-productivity/ai-transcribe/amazon-connect.md): Use AI Transcribe in your Amazon Connect solution
- [AI Transcribe via Direct Websocket](https://docs.asapp.com/ai-productivity/ai-transcribe/direct-websocket.md): Use a websocket URL to send audio media to AI Transcribe
- [Deploying AI Transcribe for Genesys AudioHook](https://docs.asapp.com/ai-productivity/ai-transcribe/genesys-audiohook.md): Use AI Transcribe in your Genesys Audiohook application
- [AI Transcribe Product Guide](https://docs.asapp.com/ai-productivity/ai-transcribe/product-guide.md): Learn more about the use of AI Transcribe and its features
- [Deploy AI Transcribe into SIPREC via Media Gateway](https://docs.asapp.com/ai-productivity/ai-transcribe/siprec.md): Integrate AI Transcribe into your SIPREC system using ASAPP Media Gateway
- [Deploying AI Transcribe for Twilio](https://docs.asapp.com/ai-productivity/ai-transcribe/twilio.md): Use AI Transcribe with Twilio
- [Check for spelling mistakes](https://docs.asapp.com/apis/autocompose/check-for-spelling-mistakes.md): Get spelling correction for a message as it is being typed, if there is a misspelling. Only the current word will be corrected, once it's fully typed (so it is recommended to call this endpoint after space characters).
- [Create a custom response](https://docs.asapp.com/apis/autocompose/create-a-custom-response.md): Add a single custom response for an agent
- [Create a message analytic event](https://docs.asapp.com/apis/autocompose/create-a-message-analytic-event.md): To improve the performance of ASAPP suggestions, provide information about the actions performed by the agent while composing a message by creating `message-analytic-events`.
- [Create a MessageSent analytics event](https://docs.asapp.com/apis/autocompose/create-a-messagesent-analytics-event.md): Create a MessageSent analytics event describing the agent's usage of AutoCompose augmentation features while composing a message
- [Create a response folder](https://docs.asapp.com/apis/autocompose/create-a-response-folder.md): Add a single folder for an agent
- [Delete a custom response](https://docs.asapp.com/apis/autocompose/delete-a-custom-response.md): Delete a specific custom response for an agent
- [Delete a response folder](https://docs.asapp.com/apis/autocompose/delete-a-response-folder.md): Delete a folder for an agent
- [Evaluate profanity](https://docs.asapp.com/apis/autocompose/evaluate-profanity.md): Get an evaluation of a text to verify if it contains profanity, obscenity or other unwanted words. This service should be called before sending a message to prevent the agent from sending profanities in the chat.
- [Generate suggestions](https://docs.asapp.com/apis/autocompose/generate-suggestions.md): Get suggestions for the next agent message in the conversation.
- [Get autopilot greetings](https://docs.asapp.com/apis/autocompose/get-autopilot-greetings.md): Get autopilot greetings for an agent
- [Get autopilot greetings status](https://docs.asapp.com/apis/autocompose/get-autopilot-greetings-status.md): Get autopilot greetings status for an agent
- [Get custom responses](https://docs.asapp.com/apis/autocompose/get-custom-responses.md): Get custom responses for an agent. Responses are sorted by title, and folders are sorted by name.
- [Get settings for AutoCompose clients](https://docs.asapp.com/apis/autocompose/get-settings-for-autocompose-clients.md): Get settings for AutoCompose clients, such as whether any features should not be used. It may be desirable to disable some features in high-latency scenarios.
- [List the global responses](https://docs.asapp.com/apis/autocompose/list-the-global-responses.md): Get the global responses and folder organization for a company. Responses are sorted by text, and folders are sorted by name.
- [Update a custom response](https://docs.asapp.com/apis/autocompose/update-a-custom-response.md): Update a specific custom response for an agent
- [Update a response folder](https://docs.asapp.com/apis/autocompose/update-a-response-folder.md): Update a folder for an agent
- [Update autopilot greetings](https://docs.asapp.com/apis/autocompose/update-autopilot-greetings.md): Update autopilot greetings for an agent
- [Update autopilot greetings status](https://docs.asapp.com/apis/autocompose/update-autopilot-greetings-status.md): Update autopilot greetings status for an agent
- [Create free text summary](https://docs.asapp.com/apis/autosummary/create-free-text-summary.md): Generates a concise, human-readable summary of a conversation.
- [Create structured data](https://docs.asapp.com/apis/autosummary/create-structured-data.md): Creates and returns set of structured data about a conversation that is already known to ASAPP.
- [Get conversation intent](https://docs.asapp.com/apis/autosummary/get-conversation-intent.md): Retrieves the primary intent of a conversation, represented by both an intent code and a human-readable intent name. If no intent is detected, "NO_INTENT" is returned.
- [Get free text summary](https://docs.asapp.com/apis/autosummary/get-free-text-summary.md): <Warning> **Deprecated**
- [Provide feedback.](https://docs.asapp.com/apis/autosummary/provide-feedback.md): Create a feedback event with the full and updated summary. Each event is associated with a specific summary id.
- [Get Twilio media stream url](https://docs.asapp.com/apis/autotranscribe-media-gateway/get-twilio-media-stream-url.md): Returns url where [Twilio media stream](/autotranscribe/deploying-autotranscribe-for-twilio) should be sent to.
- [Start streaming](https://docs.asapp.com/apis/autotranscribe-media-gateway/start-streaming.md): This starts the transcription of the audio stream.
- [Stop streaming](https://docs.asapp.com/apis/autotranscribe-media-gateway/stop-streaming.md): This stops the transcription of the audio stream.
- [Get streaming URL](https://docs.asapp.com/apis/autotranscribe/get-streaming-url.md): Get [websocket streaming URL](/autotranscribe/deploying-autotranscribe-via-websocket) to transcribe audio in real time. This websocket is used to send audio to ASAPP's transcription service and receive transcription results.
- [Create a custom vocabulary](https://docs.asapp.com/apis/configuration/custom-vocabularies/create-custom-vocabularies.md): Creates a new custom vocabulary configuration to improve transcription accuracy.
- [Delete a custom vocabulary](https://docs.asapp.com/apis/configuration/custom-vocabularies/delete-custom-vocabularies.md): Deletes a custom vocabulary configuration
- [Retrieve a custom vocabulary](https://docs.asapp.com/apis/configuration/custom-vocabularies/get-custom-vocabularies.md): Get a custom vocabulary configuration
- [List custom vocabularies](https://docs.asapp.com/apis/configuration/custom-vocabularies/list-custom-vocabularies.md): Retrieves all custom vocabulary configurations.
- [Retrieve a redaction entity](https://docs.asapp.com/apis/configuration/redaction-entities/get-redaction-entity.md): Get a specific redaction entity with a entity id
- [List redaction entities](https://docs.asapp.com/apis/configuration/redaction-entities/list-redaction-entities.md): Lists all available redaction entities and their current activation status across different policies.
- [Update a redaction entity](https://docs.asapp.com/apis/configuration/redaction-entities/update-redaction-entity.md): Update the policies of a specific redaction entity. Only the policies field can be modified.
- [Create a segment](https://docs.asapp.com/apis/configuration/segments/create-segment.md): Creates a new `segment` to organize structured data extraction based on conversation metadata.
- [Delete a segment](https://docs.asapp.com/apis/configuration/segments/delete-segment.md): Delete a specific segment specifying the id
- [Retrieve a segment](https://docs.asapp.com/apis/configuration/segments/get-segment.md): Get a specific segment specifying the id
- [List segments](https://docs.asapp.com/apis/configuration/segments/list-segments.md): Retrieves a list of all segments.
- [Partial update a segment](https://docs.asapp.com/apis/configuration/segments/update-segment.md): Update a specific segment specifying the id
- [Create a structured data field](https://docs.asapp.com/apis/configuration/structured-data-fields/create-structured-data-field.md): Creates a new structured data field configuration that defines what information should be extracted from conversations.
- [Delete a structured data field](https://docs.asapp.com/apis/configuration/structured-data-fields/delete-structured-data-field.md): Delete a specific structured data field specifying the id
- [Retrieve a structured data field](https://docs.asapp.com/apis/configuration/structured-data-fields/get-structured-data-field.md): Get a specific structured data field specifying the id
- [List structured data fields](https://docs.asapp.com/apis/configuration/structured-data-fields/list-structured-data-fields.md): Retrieves a list of all configured structured data fields.
- [Update a structured data field](https://docs.asapp.com/apis/configuration/structured-data-fields/update-structured-data-field.md): Update a specific structured data field specifying the id
- [Authenticate a user in a conversation](https://docs.asapp.com/apis/conversations/authenticate-a-user-in-a-conversation.md): Stores customer-specific authentication credentials for use in integrated flows.
- [Create or update a conversation](https://docs.asapp.com/apis/conversations/create-or-update-a-conversation.md): Creates a new conversation or updates an existing one based on the provided `externalId`.
- [List conversations](https://docs.asapp.com/apis/conversations/list-conversations.md): Retrieves a list of conversation resources that match the specified criteria.
- [Retrieve a conversation](https://docs.asapp.com/apis/conversations/retrieve-a-conversation.md): Retrieves the details of a specific conversation using its `conversationId`.
- [List feed dates](https://docs.asapp.com/apis/file-exporter/list-feed-dates.md): Lists dates for a company feed/version/format
- [List feed files](https://docs.asapp.com/apis/file-exporter/list-feed-files.md): Lists files for a company feed/version/format/date/interval
- [List feed formats](https://docs.asapp.com/apis/file-exporter/list-feed-formats.md): Lists feed formats for a company feed/version/
- [List feed intervals](https://docs.asapp.com/apis/file-exporter/list-feed-intervals.md): Lists intervals for a company feed/version/format/date
- [List feed versions](https://docs.asapp.com/apis/file-exporter/list-feed-versions.md): Lists feed versions for a company
- [List feeds](https://docs.asapp.com/apis/file-exporter/list-feeds.md): Lists feed names for a company
- [Retrieve a feed file](https://docs.asapp.com/apis/file-exporter/retrieve-a-feed-file.md): Retrieves a feed file URL for a company feed/version/format/date/interval/file
- [Get Twilio media stream url](https://docs.asapp.com/apis/genagent-media-gateway/get-twilio-media-stream-url.md): Returns url where Twilio media stream should be sent to.
- [Analyze conversation](https://docs.asapp.com/apis/generativeagent/analyze-conversation.md): Call this API to trigger GenerativeAgent to analyze and respond to a conversation.
- [Create Call Transfer](https://docs.asapp.com/apis/generativeagent/create-call-transfer.md): Creates a new Call Transfer resource that represents an attempt to transfer a call from your IVR or CCaaS to ASAPP.
- [Create stream URL](https://docs.asapp.com/apis/generativeagent/create-stream-url.md): This API creates a generative agent event streaming URL to start a streaming connection (SSE).
- [Get Call Transfer](https://docs.asapp.com/apis/generativeagent/get-call-transfer.md): Get Call Transfer resource by ID.
- [Get GenerativeAgent state](https://docs.asapp.com/apis/generativeagent/get-generativeagent-state.md): This API provides the current state of the generative agent for a given conversation.
- [Check ASAPP's API's health.](https://docs.asapp.com/apis/health-check/check-asapps-apis-health.md): The API Health check endpoint enables you to check the operational status of our API platform.
- [Create a submission](https://docs.asapp.com/apis/knowledge-base/create-a-submission.md): Initiate a request to add a new article or update an existing one. The provided title and content will be processed to create the final version of the submission.
- [Retrieve a submission](https://docs.asapp.com/apis/knowledge-base/retrieve-a-submission.md): Obtain the details of a specific submission using its unique identifier.
- [Retrieve an article](https://docs.asapp.com/apis/knowledge-base/retrieve-an-article.md): Fetch a specific article by its unique identifier. If the article has not been created because the associated submission was not approved, a 404 status will be returned.
- [Create a message](https://docs.asapp.com/apis/messages/create-a-message.md): Creates a message object, adding it to an existing conversation.
- [Create multiple messages](https://docs.asapp.com/apis/messages/create-multiple-messages.md): This creates multiple message objects at once, adding them to an existing conversation.
- [List messages](https://docs.asapp.com/apis/messages/list-messages.md): Lists all messages within a conversation.
- [List messages with an externalId](https://docs.asapp.com/apis/messages/list-messages-with-an-externalid.md): Get all messages from a conversation.
- [Retrieve a message](https://docs.asapp.com/apis/messages/retrieve-a-message.md): Retrieve the details of a message from a conversation.
- [Add a conversation metadata](https://docs.asapp.com/apis/metadata/add-a-conversation-metadata.md): Add metadata attributes of one issue/conversation
- [Add a customer metadata](https://docs.asapp.com/apis/metadata/add-a-customer-metadata.md): Add metadata attributes of one customer
- [Add an agent metadata](https://docs.asapp.com/apis/metadata/add-an-agent-metadata.md): Add metadata attributes of one agent
- [Add multiple agent metadata](https://docs.asapp.com/apis/metadata/add-multiple-agent-metadata.md): Add multiple agent metadata items; submit items in a batch in one request
- [Add multiple conversation metadata](https://docs.asapp.com/apis/metadata/add-multiple-conversation-metadata.md): Add multiple issue/conversation metadata items; submit items in a batch in one request
- [Add multiple customer metadata](https://docs.asapp.com/apis/metadata/add-multiple-customer-metadata.md): Add multiple customer metadata items; submit items in a batch in one request
- [Overview](https://docs.asapp.com/apis/overview.md): Overview of the ASAPP API
- [Building a GenerativeAgent](https://docs.asapp.com/generativeagent/build-overview.md): Learn how GenerativeAgent works and the key components you'll configure.
- [Adding a use case to GenerativeAgent](https://docs.asapp.com/generativeagent/build/adding-a-use-case.md): Learn how to add new use cases to GenerativeAgent by creating tasks and functions
- [Connect Your APIs](https://docs.asapp.com/generativeagent/configuring/connect-apis.md): Learn how to connect your APIs to GenerativeAgent with API Connections
- [Adapters in API Connections](https://docs.asapp.com/generativeagent/configuring/connect-apis/adapters.md): Learn how to connect GenerativeAgent to third-party platforms using adapters
- [Authentication Methods](https://docs.asapp.com/generativeagent/configuring/connect-apis/authentication-methods.md): Learn how to configure Authentication methods for API connections.
- [Custom Code API Connections](https://docs.asapp.com/generativeagent/configuring/connect-apis/code-api-connections.md): Create custom API connections using JavaScript code
- [API Design Best Practices for GenerativeAgent](https://docs.asapp.com/generativeagent/configuring/connect-apis/designing-apis-for-generativeagent.md): Learn how to design APIs that integrate smoothly with GenerativeAgent.
- [MCP Servers in API Connections](https://docs.asapp.com/generativeagent/configuring/connect-apis/mcp-server.md): Learn how to connect GenerativeAgent to an MCP server
- [Mock API Users](https://docs.asapp.com/generativeagent/configuring/connect-apis/mock-apis.md): Learn how to mock APIs for testing and development.
- [Connecting your Knowledge Base](https://docs.asapp.com/generativeagent/configuring/connecting-your-knowledge-base.md): Learn how to import, sync, and deploy your Knowledge Base for GenerativeAgent.
- [Add via API](https://docs.asapp.com/generativeagent/configuring/connecting-your-knowledge-base/add-via-api.md): Learn how to add Knowledge Base articles programmatically using the API
- [Custom Knowledge Base Connectors](https://docs.asapp.com/generativeagent/configuring/connecting-your-knowledge-base/custom-kb-connectors.md): Connect a third-party knowledge base to GenerativeAgent using API Connections
- [Conversations](https://docs.asapp.com/generativeagent/configuring/conversations.md): Review and analyze GenerativeAgent conversations to improve performance.
- [Deploying to GenerativeAgent](https://docs.asapp.com/generativeagent/configuring/deploying-to-generativeagent.md): Learn how to deploy GenerativeAgent.
- [Functional Testing](https://docs.asapp.com/generativeagent/configuring/functional-testing.md): Learn how to test GenerativeAgent to ensure it handles customer scenarios correctly before production launch.
- [Previewer](https://docs.asapp.com/generativeagent/configuring/previewer.md): Learn how to use the Previewer in AI Console to test and refine your GenerativeAgent's behavior
- [Tasks Best Practices](https://docs.asapp.com/generativeagent/configuring/task-best-practices.md): Improve task writing by following best practices
- [API Functions](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/api-functions.md): Connect to your existing APIs to fetch data or perform actions with API Functions.
- [Bricks](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/bricks.md): A modular system for composing prompts from reusable and configurable fragments
- [Conditional Templates](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/conditional-templates.md)
- [Enter a Specific Task](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/enter-specific-task.md): Learn how to enter a specific task for GenerativeAgent
- [Human-in-the-loop Agent Function](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/hila-function.md): Involve a human agent into a conversation with HILA Function
- [Improving Tasks](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/improving.md): Learn how to improve task performance
- [Input Variables](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/input-variables.md): Learn how to pass information from your application to GenerativeAgent.
- [Keep Fields](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/keep-fields.md): Learn how to keep fields from API responses so GenerativeAgent can use them for more calls
- [Managing Configuration Branches](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/local-configs.md): Learn how to create and manage local branches for GenerativeAgent configurations.
- [Mock API Connections](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/mock-api.md)
- [Reference Variables](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/reference-variables.md): Learn how to use reference variables to store and reuse data from function responses
- [Set Variable Functions](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/set-variable.md): Save a value from the conversation with a Set Variable Function.
- [System Transfer Functions](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/system-transfer.md): Signal conversation control transfer to external systems with System Transfer Functions.
- [Test Scenarios](https://docs.asapp.com/generativeagent/configuring/tasks-and-functions/test-scenarios.md): Learn how to create and use Test Scenarios to test conversations with GenerativeAgent.
- [Getting Started](https://docs.asapp.com/generativeagent/getting-started.md)
- [Go Live](https://docs.asapp.com/generativeagent/go-live.md)
- [Human in the Loop Agent](https://docs.asapp.com/generativeagent/human-in-the-loop.md): Learn how GenerativeAgent works with human agents to handle complex cases requiring expert guidance or approval.
- [Approver Mode](https://docs.asapp.com/generativeagent/human-in-the-loop/approver-mode.md): Learn how human agents review and refine generated responses to ensure safe, accurate, and on-brand customer interactions.
- [HILA in Salesforce](https://docs.asapp.com/generativeagent/human-in-the-loop/salesforce.md): Set up the Human in the Loop Agent (HILA) integration in your existing Salesforce implementation.
- [GenerativeAgent Integration Overview](https://docs.asapp.com/generativeagent/integrate.md): High-level guide to integrating GenerativeAgent with your systems - channel integration and backend connections
- [Amazon Connect](https://docs.asapp.com/generativeagent/integrate/amazon-connect-pstn.md): Learn how to integrate GenerativeAgent into Amazon Connect
- [Call Transfer over PSTN](https://docs.asapp.com/generativeagent/integrate/call-transfer-pstn.md): Learn how to use call transfers to handle GA calls with any platform
- [Example Interactions](https://docs.asapp.com/generativeagent/integrate/example-interactions.md)
- [Genesys AudioConnector for GenerativeAgent](https://docs.asapp.com/generativeagent/integrate/genesys-audiohook.md): Learn how to integrate GenerativeAgent into Genesys Cloud using our Genesys AudioConnector integration.
- [Handling GenerativeAgent Events](https://docs.asapp.com/generativeagent/integrate/handling-events.md)
- [SIP Transfers](https://docs.asapp.com/generativeagent/integrate/sip-transfers.md): Choose between API-based or SIP headers approaches for integrating GenerativeAgent with SIP
- [API-based SIP Transfers](https://docs.asapp.com/generativeagent/integrate/sip-transfers-api.md): Use REST API calls to pass rich context data for SIP transfers with unlimited complexity
- [SIP Headers Transfer](https://docs.asapp.com/generativeagent/integrate/sip-transfers-headers.md): Use SIP headers to pass context directly in transfers without API calls
- [Direct API Integration](https://docs.asapp.com/generativeagent/integrate/text-only-generativeagent.md)
- [Twilio Voice](https://docs.asapp.com/generativeagent/integrate/twilio-streams.md): Learn how to integrate GenerativeAgent into Twilio using Twilio Media Stream
- [ASAPP SDK (Web)](https://docs.asapp.com/generativeagent/integrate/web-sdk.md): Integrate GenerativeAgent chat into your website with our customizable web SDK
- [Zendesk Talk](https://docs.asapp.com/generativeagent/integrate/zendesk-talk.md): Learn how to integrate GenerativeAgent with Zendesk Talk for automated call handling and ticket creation
- [Conversation Monitoring](https://docs.asapp.com/generativeagent/observe/evaluators/conversation-monitoring.md): Monitor and review conversations for compliance and quality assurance using GenerativeAgent.
- [Goal Completion](https://docs.asapp.com/generativeagent/observe/evaluators/goal-completion.md): Spot and review customer goals not being met during GenerativeAgent interactions.
- [Manual Annotation](https://docs.asapp.com/generativeagent/observe/evaluators/manual-annotation.md): Human-in-the-loop evaluation through manual conversation review
- [Reporting](https://docs.asapp.com/generativeagent/reporting.md): Learn how to track and analyze GenerativeAgent's performance.
- [Developer Quickstart](https://docs.asapp.com/getting-started/developers.md): Learn how to get started using ASAPPs APIs
- [Error Handling](https://docs.asapp.com/getting-started/developers/error-handling.md): Learn how ASAPP returns Errors in the API
- [Health Check](https://docs.asapp.com/getting-started/developers/health-check.md): Check the operational status of ASAPP's API platform
- [API Rate Limits and Retry Logic](https://docs.asapp.com/getting-started/developers/rate-limits.md): Learn about API rate limits and recommended retry logic.
- [Setup ASAPP](https://docs.asapp.com/getting-started/setup.md): Learn how to get started with your ASAPP account
- [AI Console](https://docs.asapp.com/getting-started/setup/ai-console.md): Central dashboard for configuring and managing ASAPP products
- [Audit Logs](https://docs.asapp.com/getting-started/setup/audit-logs.md): Learn how to view, search, and export audit logs to track changes in AI Console.
- [Manage Users](https://docs.asapp.com/getting-started/setup/manage-users.md): Learn how to set up and manage users.
- [Human + AI](https://docs.asapp.com/human-+-ai.md): Empower GenerativeAgent with Human in the Loop Agent (HILA) and Agent Desk.
- [Release Notes](https://docs.asapp.com/releases/overview.md): New updates and improvements across ASAPP products
- [Reporting and Insights](https://docs.asapp.com/reporting.md)
- [ASAPP Messaging Feed Schemas](https://docs.asapp.com/reporting/asapp-messaging-feeds.md)
- [File Exporter](https://docs.asapp.com/reporting/file-exporter.md): Learn how to use File Exporter to retrieve data from Standalone ASAPP Services.
- [File Exporter Feed Schema](https://docs.asapp.com/reporting/fileexporter-feeds.md)
- [Metadata Ingestion API](https://docs.asapp.com/reporting/metadata-ingestion.md): Learn how to send metadata via Metadata Ingestion API.
- [Building a Real-Time Event API](https://docs.asapp.com/reporting/real-time-event-api.md): Learn how to implement ASAPP's real-time event API to receive activity, journey, and queue state updates.
- [Retrieving Data for ASAPP Messaging](https://docs.asapp.com/reporting/retrieve-messaging-data.md): Learn how to retrieve data from ASAPP Messaging
- [Secure Data Retrieval](https://docs.asapp.com/reporting/secure-data-retrieval.md): Learn how to set up secure communication between ASAPP and your real-time event API.
- [Transmitting Data via S3](https://docs.asapp.com/reporting/send-s3.md)
- [Transmitting Data to SFTP](https://docs.asapp.com/reporting/send-sftp.md)
- [Transmitting Data to ASAPP](https://docs.asapp.com/reporting/transmitting-data-to-asapp.md): Learn how to transmit data to ASAPP for Applications and AI Services.
- [Security](https://docs.asapp.com/security.md)
- [Data Redaction](https://docs.asapp.com/security/data-redaction.md): Learn how Data Redaction removes sensitive data from your conversations.
- [External IP Blocking](https://docs.asapp.com/security/external-ip-blocking.md): Use External IP Blocking to block IP addresses from accessing your data.
- [Warning about CustomerInfo and Sensitive Data](https://docs.asapp.com/security/warning-about-customerinfo-and-sensitive-data.md): Learn how to securely handle Customer Information.
- [Support Overview](https://docs.asapp.com/support.md)
- [Reporting Issues to ASAPP](https://docs.asapp.com/support/reporting-issues-to-asapp.md)
- [Service Desk Information](https://docs.asapp.com/support/service-desk-information.md)
- [Troubleshooting Guide](https://docs.asapp.com/support/troubleshooting-guide.md)
- [Welcome to ASAPP](https://docs.asapp.com/welcome.md): A personal AI agent for every customer with ASAPP Customer Experience Platform (CXP)

## OpenAPI Specs

- [mg-genagent](https://docs.asapp.com/api-specs/mg-genagent.yaml)
- [generativeagent](https://docs.asapp.com/api-specs/generativeagent.yaml)
- [autocompose](https://docs.asapp.com/api-specs/autocompose.yaml)
- [partner-configuration](https://docs.asapp.com/api-specs/partner-configuration.yaml)
- [asapp-messaging-feeds](https://docs.asapp.com/reporting/asapp-messaging-feeds.json)
- [mg-autotranscribe](https://docs.asapp.com/api-specs/mg-autotranscribe.yaml)
- [metadata-ingestion](https://docs.asapp.com/api-specs/metadata-ingestion.yaml)
- [knowledge-base](https://docs.asapp.com/api-specs/knowledge-base.yaml)
- [healthcheck](https://docs.asapp.com/api-specs/healthcheck.yaml)
- [fileexporter](https://docs.asapp.com/api-specs/fileexporter.yaml)
- [conversations](https://docs.asapp.com/api-specs/conversations.yaml)
- [autotranscribe](https://docs.asapp.com/api-specs/autotranscribe.yaml)
- [autosummary](https://docs.asapp.com/api-specs/autosummary.yaml)
- [openapi](https://docs.asapp.com/api-specs/openapi.yaml)