# SentiOne Automate Documentation

> SentiOne Automate documentation

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Knowledge Center](https://automate.help.sentione.com/docs/getting-started.md)
- [Projects](https://automate.help.sentione.com/docs/projects.md)
- [Demo gallery](https://automate.help.sentione.com/docs/demo-gallery.md): Feel free to check out our demos!
- [Customer technical support](https://automate.help.sentione.com/docs/clients-technical-support.md)
- [Troubleshooting / Known Issues](https://automate.help.sentione.com/docs/known-issues.md)
- [Large Language Models (LLMs)](https://automate.help.sentione.com/docs/large-language-models-llms.md): List of supported models
- [OpenAI](https://automate.help.sentione.com/docs/openai.md): Connect Automate with OpenAI infrastructure
- [OpenAI via Microsoft Azure](https://automate.help.sentione.com/docs/openai-via-microsoft-azure.md): Connect Automate with your deployment in Azure private cloud
- [Open source LLM models](https://automate.help.sentione.com/docs/open-source-llm-models.md): Examples on connecting SentiOne Automate to popular LLM providers
- [Retrieval Augmented Generation](https://automate.help.sentione.com/docs/retrieval-augmented-generation.md): Quick tutorial on creating RAG based bots
- [Flows overview](https://automate.help.sentione.com/docs/canvas.md)
- [Blocks](https://automate.help.sentione.com/docs/blocks-description.md)
- [Say](https://automate.help.sentione.com/docs/say.md)
- [Say with Fallbacks](https://automate.help.sentione.com/docs/say-with-fallbacks.md)
- [Carousel](https://automate.help.sentione.com/docs/carousel-block-type.md)
- [Redirect](https://automate.help.sentione.com/docs/redirect.md)
- [Transfer to Flow](https://automate.help.sentione.com/docs/transfer-to-bot.md)
- [LLM Blocks](https://automate.help.sentione.com/docs/llm-blocks.md)
- [LLM Say](https://automate.help.sentione.com/docs/llm-say.md)
- [LLM Integration](https://automate.help.sentione.com/docs/llm-integration.md)
- [Advanced blocks](https://automate.help.sentione.com/docs/integration-blocks.md)
- [Custom](https://automate.help.sentione.com/docs/custom.md)
- [Integration](https://automate.help.sentione.com/docs/integration.md)
- [NLU model](https://automate.help.sentione.com/docs/nlu-model.md)
- [Metadata](https://automate.help.sentione.com/docs/metadata.md)
- [Chat tester](https://automate.help.sentione.com/docs/overview.md)
- [Settings](https://automate.help.sentione.com/docs/settings.md)
- [Debug and message details](https://automate.help.sentione.com/docs/debug.md)
- [Multilingual Bots](https://automate.help.sentione.com/docs/multilingual-bots.md): This feature is still experimanetal and some issues may appear.
- [Commands](https://automate.help.sentione.com/docs/commands.md)
- [Global Listener](https://automate.help.sentione.com/docs/global-listener.md)
- [Flow snippets](https://automate.help.sentione.com/docs/flow-snippets.md)
- [Language support](https://automate.help.sentione.com/docs/language-support.md)
- [Comparison of available intentizer types](https://automate.help.sentione.com/docs/comparison-of-available-intentizer-types.md)
- [Entity handling by intentizer](https://automate.help.sentione.com/docs/entity-handling-by-intentizer.md): How entities may influence intent detection.
- [Automatic training set generation](https://automate.help.sentione.com/docs/automatic-training-set-generation.md)
- [Intent Detection Using Semantic Search](https://automate.help.sentione.com/docs/intent-detection-using-semantic-search.md)
- [Entities & Variables](https://automate.help.sentione.com/docs/entities-1.md)
- [Built-in entities](https://automate.help.sentione.com/docs/system-entities.md)
- [Keyword entities](https://automate.help.sentione.com/docs/keyword-enitities.md)
- [Pattern entities](https://automate.help.sentione.com/docs/pattern-entities.md)
- [Accessing variables](https://automate.help.sentione.com/docs/accessing-variables.md)
- [Overlapping entities](https://automate.help.sentione.com/docs/overlapping-entities.md): What happens when different entities are detected on same words or phrases?
- [Multi-language NLUs](https://automate.help.sentione.com/docs/multi-language-nlus.md)
- [Training phrases](https://automate.help.sentione.com/docs/training-phrases.md)
- [Phrases with similar construction placed in different intents](https://automate.help.sentione.com/docs/phrases-with-similar-construction-placed-in-different-intents.md)
- [Phrases length](https://automate.help.sentione.com/docs/phrases-length.md)
- [Short phrases without object](https://automate.help.sentione.com/docs/short-phrases-without-object.md)
- [Detection of undesirable phrases in NLU](https://automate.help.sentione.com/docs/detection-of-undesirable-phrases-in-nlu.md)
- [Advices regarding intents](https://automate.help.sentione.com/docs/advices-regarding-intents.md)
- [Entities and variables](https://automate.help.sentione.com/docs/entities-and-variables-1.md)
- [Phrases mapping](https://automate.help.sentione.com/docs/phrases-mapping.md)
- [Maintaining NLU](https://automate.help.sentione.com/docs/maintaining-nlu.md)
- [Autocorrect](https://automate.help.sentione.com/docs/autocorrect.md)
- [Operators](https://automate.help.sentione.com/docs/operators.md)
- [Extra data](https://automate.help.sentione.com/docs/extra-data.md)
- [JavaScript](https://automate.help.sentione.com/docs/javascript.md)
- [Methods and APIs overview](https://automate.help.sentione.com/docs/methods-and-apis-overview.md)
- [Arrays](https://automate.help.sentione.com/docs/arrays.md)
- [Objects](https://automate.help.sentione.com/docs/objects.md)
- [NLU API](https://automate.help.sentione.com/docs/nlu-api.md)
- [System API](https://automate.help.sentione.com/docs/system-api.md)
- [DateTime API](https://automate.help.sentione.com/docs/datetime-api.md)
- [Integrations](https://automate.help.sentione.com/docs/integrations-module.md)
- [mTLS authentication](https://automate.help.sentione.com/docs/mtls-authentication.md)
- [Secrets](https://automate.help.sentione.com/docs/secrets.md): Secrets let you store sensitive values, such as API keys or tokens, once and reuse them in integrations without exposing the full value in forms.
- [How to test your bot?](https://automate.help.sentione.com/docs/how-to-test-your-bot.md)
- [Items](https://automate.help.sentione.com/docs/items.md)
- [Documents](https://automate.help.sentione.com/docs/documents.md)
- [Connectors](https://automate.help.sentione.com/docs/connectors.md)
- [Knowledge Base API](https://automate.help.sentione.com/docs/knowledge-base-api.md)
- [Supported channels](https://automate.help.sentione.com/docs/supported-channels.md): Channel allows end-users to interact with the bot
- [Adding the Mobile SDK Channel (iOS & Android)](https://automate.help.sentione.com/docs/adding-the-mobile-sdk-channel-ios-android.md)
- [Adding the LiveChat Channel](https://automate.help.sentione.com/docs/adding-the-livechat-channel.md): This document provides detailed instructions for adding the Livechat channel.
- [Adding Slack channel](https://automate.help.sentione.com/docs/adding-slack-channel.md)
- [Adding Voice channel (Google provider)](https://automate.help.sentione.com/docs/adding-voice-channel.md)
- [Adding Voice channel (Microsoft provider)](https://automate.help.sentione.com/docs/adding-voice-channel-microsoft-provider.md)
- [Voice Channel options](https://automate.help.sentione.com/docs/voice-channel-options.md): Description of options available when configuring integration with telephony.
- [Limitations](https://automate.help.sentione.com/docs/channels-limitations.md)
- [Preparing contacts](https://automate.help.sentione.com/docs/preparing-contacts.md): How to prepare input file for dialer campaign
- [Webchat handover configuration](https://automate.help.sentione.com/docs/webchat-handover-configuration.md)
- [License management](https://automate.help.sentione.com/docs/license-key.md)
- [Arrays](https://automate.help.sentione.com/docs/learn-arrays.md): Learn using arrays by creating simple bot projects
- [Loops](https://automate.help.sentione.com/docs/loops.md): 3 ways to create loops
- [Fallbacks](https://automate.help.sentione.com/docs/fallbacks.md): Fallback responses are used when a bot has to repeat the same question - for example when the user provided wrong answer or was silent
- [Confidence in classification](https://automate.help.sentione.com/docs/confidence-in-classification.md)
- [Thresholds in scoring](https://automate.help.sentione.com/docs/thresholds-in-scoring.md)
- [Experimental features](https://automate.help.sentione.com/docs/experimental-features.md)
- [Export to Warehouse](https://automate.help.sentione.com/docs/export-to-warehouse.md)
- [Configuration](https://automate.help.sentione.com/docs/how-to-embed-webchat-on-page.md)
- [Embedding in browser (Legacy)](https://automate.help.sentione.com/docs/embedding-in-browser.md)
- [v232](https://automate.help.sentione.com/docs/v232.md)
- [v234](https://automate.help.sentione.com/docs/v234.md)
- [v241](https://automate.help.sentione.com/docs/v241.md)
- [v246](https://automate.help.sentione.com/docs/v246.md)
- [v247](https://automate.help.sentione.com/docs/v247.md)
- [v248](https://automate.help.sentione.com/docs/v248.md)
- [v259](https://automate.help.sentione.com/docs/v259.md)
- [Embeding in WebView (Legacy Mode - without Channel)](https://automate.help.sentione.com/docs/embeding-in-webview.md): Webchat PostMessage Integration Guide
- [Embeding in WebView with Channel](https://automate.help.sentione.com/docs/embeding-in-webview-with-channel.md): Webchat PostMessage Integration Guide
- [Quick replies](https://automate.help.sentione.com/docs/quick-replies.md)
- [Announcement Banner](https://automate.help.sentione.com/docs/announcement-banner.md): Notify user about some important event
- [Message with website](https://automate.help.sentione.com/docs/message-with-website.md): Notify user about some important event
- [Carousel](https://automate.help.sentione.com/docs/carousel.md)
- [ Sound & page title notifications](https://automate.help.sentione.com/docs/sound-page-title-notifications.md): 📘 Availability: This feature is available starting from webchat version v264.
- [Where can I test it?](https://automate.help.sentione.com/docs/where-i-can-test-it.md)
- [Configuration](https://automate.help.sentione.com/docs/genesys-handover.md)
- [Integration Guide](https://automate.help.sentione.com/docs/integration-guide.md): This document outlines  how to handle conversation transfers (redirects), and the logic behind conversation termination.
- [Components](https://automate.help.sentione.com/docs/components-architecture.md)
- [Voice Gateway](https://automate.help.sentione.com/docs/voice-gateway.md)
- [SQL Databases](https://automate.help.sentione.com/docs/sql-databases.md): Overview of PostgreSQL databases used by Automate Platform
- [Security](https://automate.help.sentione.com/docs/security.md)
- [2FA - Two Factor Authentication](https://automate.help.sentione.com/docs/2fa.md): Tutorial on how to handle Multi Factor Authentication in SentiOne Automate
- [Mobile SDK security](https://automate.help.sentione.com/docs/mobile-sdk-security.md)
- [Analytics](https://automate.help.sentione.com/docs/analytics-service.md)
- [Admin panel](https://automate.help.sentione.com/docs/admin-panel.md)
- [WebChat](https://automate.help.sentione.com/docs/webchat.md)
- [SSO Server](https://automate.help.sentione.com/docs/sso-server.md)
- [Dialogs](https://automate.help.sentione.com/docs/dialogs.md)
- [Channels Connector](https://automate.help.sentione.com/docs/channels-connector.md)
- [Platform API](https://automate.help.sentione.com/docs/platform-api.md)
- [DB HTTP connector](https://automate.help.sentione.com/docs/db-http-connector-api.md)
- [Storage](https://automate.help.sentione.com/docs/storage.md)
- [Charon](https://automate.help.sentione.com/docs/charon.md): Voice Gateway - SIP integration
- [Qpido](https://automate.help.sentione.com/docs/qpido.md): Voice Gateway - Dialer
- [Philotes](https://automate.help.sentione.com/docs/philotes.md): Voice Gateway - Dialer contact integration
- [Dialog-sentione](https://automate.help.sentione.com/docs/dialog-sentione.md): Voice Gateway - SentiOne Automate gateway integration
- [Pytia](https://automate.help.sentione.com/docs/pytia.md): Speech to text (ASR) integration
- [Crocotta](https://automate.help.sentione.com/docs/crocotta.md): Text to speech (TTS) integration
- [Gall](https://automate.help.sentione.com/docs/gall.md): Audio recording
- [NLU Facade](https://automate.help.sentione.com/docs/nlu-facade.md)
- [Intentizer LLM](https://automate.help.sentione.com/docs/intentizer-llm.md)
- [Gateway](https://automate.help.sentione.com/docs/gateway.md)
- [Infrastructure Requirements](https://automate.help.sentione.com/docs/infrastructure-requirements.md)
- [Pod Resources configuration](https://automate.help.sentione.com/docs/pod-memory-configuration.md)
- [XS - Minimal environment](https://automate.help.sentione.com/docs/minimal-pod-resources.md): Up to 70 concurrent conversations, no HA - suitable for testing environments
- [S - Small environment](https://automate.help.sentione.com/docs/s-small-env.md): Up to 500 concurrent conversations, no HA - suitable for non critical production environments
- [M - Medium environment](https://automate.help.sentione.com/docs/m-medium-environment.md): Up to 550 concurrent conversations, HA enabled, suitable for medium size production environments
- [L - Large environment](https://automate.help.sentione.com/docs/l-large-environment.md): Up to 800 concurrent conversations, HA enabled, suitable for big production environments
- [Dependencies (External Services)](https://automate.help.sentione.com/docs/external-services.md)
- [Kubernetes installation](https://automate.help.sentione.com/docs/kubernetes-installation.md)
- [ElasticSearch installation](https://automate.help.sentione.com/docs/elasticsearch-installation.md)
- [PostgreSQL installation](https://automate.help.sentione.com/docs/postgresql-installation.md)
- [RabbitMQ installation](https://automate.help.sentione.com/docs/rabbitmq-installation.md)
- [NFS installation](https://automate.help.sentione.com/docs/nfs-installation.md)
- [REDISAI installation](https://automate.help.sentione.com/docs/redisai-installation.md)
- [Monitoring tools installation](https://automate.help.sentione.com/docs/monitoring-tools-installation.md)
- [Installation](https://automate.help.sentione.com/docs/installation.md)
- [Upgrade](https://automate.help.sentione.com/docs/upgrade.md)
- [Upgrade tasks](https://automate.help.sentione.com/docs/upgrade-tasks.md)
- [Configuration repository](https://automate.help.sentione.com/docs/configuration-repository.md)
- [Configuring LiveChat](https://automate.help.sentione.com/docs/configuring-livechat.md): This document provides detailed instructions for configuring LiveChat in channels-connector
- [Configuring Slack](https://automate.help.sentione.com/docs/configuring-slack.md): This document provides detailed instructions for configuring Slack in channels-connector
- [Deployment checklist](https://automate.help.sentione.com/docs/deployment-checklist.md)
- [Reading application logs](https://automate.help.sentione.com/docs/reading-logs.md): How to read logs with examples
- [Logs troubleshooting](https://automate.help.sentione.com/docs/troubleshooting.md): Common error messages that appear in logs and may suggest system or bot failure
- [Components monitoring](https://automate.help.sentione.com/docs/components-monitoring.md)
- [Performance monitoring and troubleshooting](https://automate.help.sentione.com/docs/performance-monitoring-and-troubleshooting.md)
- [Redis monitoring](https://automate.help.sentione.com/docs/redis-monitoring.md)
- [Business logic monitoring](https://automate.help.sentione.com/docs/business-logic-monitoring.md)
- [Loki-stack monitoring](https://automate.help.sentione.com/docs/loki-stack-monitoring.md)
- [Minimal installation](https://automate.help.sentione.com/docs/minimal-installation.md)
- [Migrating a project between environments](https://automate.help.sentione.com/docs/migrating-a-project-between-environments.md)

## API Reference
- [Add new contact](https://automate.help.sentione.com/reference/post_dialer-campaigns-campaign-id-contacts.md): Endpoint used to add new contact to the campaign
- [Get all projects](https://automate.help.sentione.com/reference/get_projects.md): Returns a list of all projects available for the company associated with the API key. Available from version 254.
- [Get project details](https://automate.help.sentione.com/reference/get_projects-id.md): Returns detailed information about a specific project. Available from version 254.
- [Export project as ZIP](https://automate.help.sentione.com/reference/get_projects-id-export.md): Export the entire project as a ZIP file. Available from version 257.
- [Import project ZIP](https://automate.help.sentione.com/reference/post_projects-id-import.md): Import project from ZIP file. If the project with given ID exists, it will be overwritten; otherwise, a new project will be created. Trained (binary) NLU models are imported automatically when present in the ZIP. Available from version 257.
- [Search conversation sessions](https://automate.help.sentione.com/reference/post_conversations-search.md): Search for conversation sessions with filtering and pagination support. Returns session details including metadata, message counts, call summaries, and more. Set includeMessages to receive the messages of every returned conversation in the same response. Available from version 260.
- [Get conversation messages](https://automate.help.sentione.com/reference/get_conversations-internalsessionid-messages.md): Returns all messages for a single conversation session identified by its internal session ID. Available from version 261.
- [Download conversation recording](https://automate.help.sentione.com/reference/get_conversations-internalsessionid-recording.md): Downloads the audio recording for a voice conversation session identified by its internal session ID. The content type reflects the actual file format and may vary. Available from version 261.
- [Delete conversation recording](https://automate.help.sentione.com/reference/delete_conversations-internalsessionid-recording.md): Permanently deletes the audio recording associated with a conversation session. The recording is removed from Storage and the session's recording is marked as Deleted. Recordings held by an external system cannot be deleted via this API and will return 400. Returns 404 if no recording exists for this session.
- [Schedule conversation recording deletion](https://automate.help.sentione.com/reference/post_conversations-internalsessionid-recording-scheduledeletion.md): Schedules the audio recording associated with a conversation session to be deleted at the given time. A background job deletes the recording once the scheduled time has passed. If a deletion is already scheduled for this session, the existing schedule is overwritten. Recordings held by an external system cannot be scheduled for deletion via this API and will return 400.
- [Get available AI credentials](https://automate.help.sentione.com/reference/get_organization-ai-credentials.md): Get a list of available AI credentials for your organization. Available from version 255.
- [Get knowledge base documents](https://automate.help.sentione.com/reference/get_knowledge-documents.md): Get a list of knowledge base documents. Available from version 255.
- [Get knowledge base document with given key](https://automate.help.sentione.com/reference/get_knowledge-documents-key.md): Find a knowledge base document with given key. Available from version 255.
- [Upsert knowledge base document](https://automate.help.sentione.com/reference/put_knowledge-documents-key.md): Create or update a knowledge base document with the given key. Upload a CSV or XLSX file and specify AI credentials for embeddings. Available from version 255.
- [Export knowledge base document as XLSX](https://automate.help.sentione.com/reference/get_knowledge-documents-key-export-xlsx.md): Export the specified knowledge base document as an XLSX file. Available from version 256.
- [Export knowledge base document as CSV](https://automate.help.sentione.com/reference/get_knowledge-documents-key-export-csv.md): Export the specified knowledge base document as a CSV file. Available from version 256.
- [Export knowledge items as CSV](https://automate.help.sentione.com/reference/get_knowledge-items-export.md): Export all knowledge items, sorted alphabetically by a key, as a CSV file. Available from version 257.  CSV format: key, value, expiresAt (optional, ISO 8601 date format)  This export format is compatible with the import endpoint.
- [Import knowledge items from CSV](https://automate.help.sentione.com/reference/post_knowledge-items-import.md): Import or update knowledge base items from a CSV file. Available from version 257.  CSV format: key, value, expiresAt (optional, ISO 8601 date format)  The import operation will: - Create new items if the key doesn't exist - Update existing items if the key exists and values differ - Skip items that are unchanged - Fail for items that are used in connectors  Maximum file size: 10,000 rows  Returns a summary with counts of added, updated, and unchanged items.  Possible error codes: FileTooBig, DuplicateKeys, InvalidCsv, ImportFailed
- [Messages search](https://automate.help.sentione.com/reference/post_v1-analytics-message-search.md): Endpoint used to search messages
- [Sessions search](https://automate.help.sentione.com/reference/post_v1-analytics-session-search.md): Endpoint used to search sessions
- [Get active voice session statuses](https://automate.help.sentione.com/reference/get_v1-analytics-session-getactivevoicesessions.md): Returns the number of active voice sessions for all enabled phone numbers.
- [Sessions summary for periods](https://automate.help.sentione.com/reference/post_v1-billing-session-summary.md): Endpoint used to summarize periods for billing purposes
- [Interaction with bot](https://automate.help.sentione.com/reference/apiget_bot_response.md): "Endpoint used to conduct conversation with bot. It accepts user input and responds with bot answers."
- [Interaction with bot](https://automate.help.sentione.com/reference/post_gateway-stream.md): Endpoint used to conduct conversation with bot. It accepts user input and responds with bot answers. Returns response in Sever-sent events format. Stream contains zero or more PartialResponse events followed by exactly one Response or StreamError event. The final Response event contains all partial responses.
- [Attach recording](https://automate.help.sentione.com/reference/apipost_recording.md)
- [Upload recording](https://automate.help.sentione.com/reference/apipost_recording_upload.md)
- [Attach conversation data](https://automate.help.sentione.com/reference/apipost_metadata.md)
- [Attach call summary](https://automate.help.sentione.com/reference/apipost_call_summary.md)
- [Pass thread to the specified owner](https://automate.help.sentione.com/reference/apipost_thread_pass.md)
- [Get owner of the thread](https://automate.help.sentione.com/reference/apiget_thread_owner.md)
- [Getting Started With Your API](https://automate.help.sentione.com/reference/getting-started-with-your-api.md): This page will help you get started with Test.

## Pages
- [SentiOne Automate service status](https://automate.help.sentione.com/page/status-page.md)

## Changelog
- [v265 Mobile Channels Are Here 📱](https://automate.help.sentione.com/changelog/v265.md)
- [v264 Sound Notifications & Sensitive Data Control 🔔](https://automate.help.sentione.com/changelog/v264.md)
- [v263 Expression Autocomplete Everywhere ✨](https://automate.help.sentione.com/changelog/v263.md)
- [v262 New Languages & Conversation Logging 🌍](https://automate.help.sentione.com/changelog/v262.md)
- [v261 New Intent Models & Enhanced API 🔍](https://automate.help.sentione.com/changelog/v261.md)
- [v260 Enhanced Intent Recognition & Voice Features 🤖](https://automate.help.sentione.com/changelog/v260.md)
- [v259 Cross-Project Flows & Enhanced WebChat 🔄](https://automate.help.sentione.com/changelog/v259.md)
- [v258 Secrets Management & Security Hardening 🔐](https://automate.help.sentione.com/changelog/v258.md)
- [v257 Enhanced Analytics & Voice Features 📊](https://automate.help.sentione.com/changelog/v257.md)
- [v256 EntraID Single Sign-On Security Hardening🔒](https://automate.help.sentione.com/changelog/v256.md)