# Sensay API ## Description This is version `2025-03-25` of this API documentation. Last update on Dec 1, 2025. # Introduction *Leverage Sensay’s technology to build your own custom products, creating hyper-personalised chatbots.* The **Sensay API** provides a unified way to build, manage, and integrate AI-driven chatbots (replicas) and conversations into your applications and workflows. It’s designed to support a variety of use cases, from embedding chat into web and mobile apps, to syncing activity across platforms like Discord, Telegram, and custom integrations. With its consistent structure and predictable responses, the API makes it easy to manage replicas, handle chat histories, generate completions, analyze usage, and maintain user data—all while maintaining security and scalability. ## How to use this guide This guide is structured to help you find what you need quickly: - **Getting started** – Learn the basics of authenticating and making your first request. - **Generating the SDK** – Automate API integration by generating and using a client SDK. - **Authentication** – Understand how to manage tokens and secure your calls. - **Endpoints** – Each major feature, such as Replicas, Conversations, Analytics, Users, and Knowledge base, has its own section with usage examples, request/response formats, and best practices. For more information about Sensay, visit our homepage: [https://www.sensay.io](https://www.sensay.io). For requesting an API key, visit [Sensay API account request form](https://docs.google.com/forms/d/11ExevrfKClc7IfQf7kjEpIiLqHtHE_E42Y752KV7mYY/). You can play around with the API via Swagger UI at [https://api.sensay.io/ui](https://api.sensay.io/ui). Don't forget to **join the [Sensay API announcements Telegram channel](https://t.me/sensay_api)** to be notified in advance of breaking changes and new major features! This API is OpenAPI 3.0.3-compliant and as such you can make use of the extensive tools developed for OpenAPI: find them at [https://tools.openapis.org](https://tools.openapis.org/). ## Servers - https://api.sensay.io: https://api.sensay.io () ## Topics - [Getting started](https://docs.sensay.io/topic/topic-getting-started.md) - [Getting deeper: Knowledge base](https://docs.sensay.io/topic/topic-getting-deeper-knowledge-base.md) - [Conceptual model](https://docs.sensay.io/topic/topic-conceptual-model.md) - [Generating the SDK](https://docs.sensay.io/topic/topic-generating-the-sdk.md) - [Authentication](https://docs.sensay.io/authentication.md) - [Responses](https://docs.sensay.io/topic/topic-responses.md) - [Pagination](https://docs.sensay.io/topic/topic-pagination.md) - [Versioning](https://docs.sensay.io/topic/topic-versioning.md) - [Feature requests](https://docs.sensay.io/topic/topic-feature-requests.md) - [Troubleshooting](https://docs.sensay.io/topic/topic-troubleshooting.md) - [In-depth: Conversations](https://docs.sensay.io/topic/topic-in-depth-conversations.md) - [Tutorial: Next.js](https://docs.sensay.io/topic/topic-tutorial-next-js.md) ## Endpoints and operations ### [Conversations](https://docs.sensay.io/group/endpoint-conversations.md) - [List messages in a chat conversation](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chats-parameter-messages.md) - [Get conversation details](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-conversations-parameter.md) - [Update conversation details](https://docs.sensay.io/operation/operation-patch-v1-replicas-parameter-conversations-parameter.md) - [List replica's conversations](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-conversations.md) - [List mentions in a conversation](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-conversations-parameter-mentions.md) - [List messages in a conversation](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-conversations-parameter-messages.md) ### [Analytics](https://docs.sensay.io/group/endpoint-analytics.md) - [Get replica historical conversation analytics](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-analytics-conversations-historical.md) - [Get replica source analytics](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-analytics-conversations-sources.md) ### [Replicas](https://docs.sensay.io/group/endpoint-replicas.md) - [List replicas](https://docs.sensay.io/operation/operation-get-v1-replicas.md) - [Create a replica](https://docs.sensay.io/operation/operation-post-v1-replicas.md) - [Get a replica](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter.md) - [Updates a replica](https://docs.sensay.io/operation/operation-put-v1-replicas-parameter.md) - [Delete a replica](https://docs.sensay.io/operation/operation-delete-v1-replicas-parameter.md) ### [API Keys](https://docs.sensay.io/group/endpoint-api-keys.md) - [Redeem an API key invitation](https://docs.sensay.io/operation/operation-post-v1-api-keys-invites-parameter-redeem.md) ### [Chat history](https://docs.sensay.io/group/endpoint-chat-history.md) - [Get chat history](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chat-history.md) - [Create a chat history entry](https://docs.sensay.io/operation/operation-post-v1-replicas-parameter-chat-history.md) - [Get Web chat history](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chat-history-web.md) ### [Chat Completions](https://docs.sensay.io/group/endpoint-chat-completions.md) - [Generate a completion](https://docs.sensay.io/operation/operation-post-v1-replicas-parameter-chat-completions.md) ### [Users](https://docs.sensay.io/group/endpoint-users.md) - [Get the current user](https://docs.sensay.io/operation/operation-get-v1-users-me.md) - [Update the current user](https://docs.sensay.io/operation/operation-put-v1-users-me.md) - [Delete the current user](https://docs.sensay.io/operation/operation-delete-v1-users-me.md) - [Create a user](https://docs.sensay.io/operation/operation-post-v1-users.md) - [Get a user by ID](https://docs.sensay.io/operation/operation-get-v1-users-parameter.md) ### [Knowledge base](https://docs.sensay.io/group/endpoint-knowledge-base.md) - [List all knowledge base entries](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-knowledge-base.md) - [Create a knowledge base entry](https://docs.sensay.io/operation/operation-post-v1-replicas-parameter-knowledge-base.md) - [Get knowledge base entry by ID](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-knowledge-base-parameter.md) - [Delete knowledge base entry by ID](https://docs.sensay.io/operation/operation-delete-v1-replicas-parameter-knowledge-base-parameter.md) - [Update knowledge base entry](https://docs.sensay.io/operation/operation-patch-v1-replicas-parameter-knowledge-base-parameter.md) - [Get supported file types](https://docs.sensay.io/operation/operation-get-v1-knowledge-base-file-types.md) ### [Usage](https://docs.sensay.io/group/endpoint-usage.md) - [Get usage metrics](https://docs.sensay.io/operation/operation-get-v1-users-me-usage.md) ### [Telegram integration](https://docs.sensay.io/group/endpoint-telegram-integration.md) - [Get Telegram chat history](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chat-history-telegram.md) - [Create a Telegram chat history entry](https://docs.sensay.io/operation/operation-post-v1-replicas-parameter-chat-history-telegram.md) - [Generate a Telegram completion](https://docs.sensay.io/operation/operation-post-v1-replicas-parameter-chat-completions-telegram.md) - [Create a replica Telegram integration](https://docs.sensay.io/operation/operation-post-v1-replicas-parameter-integrations-telegram.md) - [Delete a replica Telegram integration](https://docs.sensay.io/operation/operation-delete-v1-replicas-parameter-integrations-telegram.md) ### [Discord integration](https://docs.sensay.io/group/endpoint-discord-integration.md) - [Get Discord chat history](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chat-history-discord.md) - [Create a replica Discord integration](https://docs.sensay.io/operation/operation-post-v1-replicas-parameter-integrations-discord.md) ### [Chat-widget integration](https://docs.sensay.io/group/endpoint-chat-widget-integration.md) - [Get Embed chat history](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chat-history-embed.md) ### [Experimental](https://docs.sensay.io/group/endpoint-experimental.md) - [Generate a completion (OpenAI-compatible, non-streaming)](https://docs.sensay.io/operation/operation-post-v1-experimental-replicas-parameter-chat-completions.md) ### [Chats](https://docs.sensay.io/group/endpoint-chats.md) - [List replica's chats](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chats.md) - [Get chat details](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chats-parameter.md) - [List conversations in a specific chat](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chats-parameter-conversations.md) - [Get a chat conversation details](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chats-parameter-conversations-parameter.md) - [List messages in a chat conversation](https://docs.sensay.io/operation/operation-get-v1-replicas-parameter-chats-parameter-conversations-parameter-messages.md) [Powered by Bump.sh](https://bump.sh)