Sensay API
Sensay API - Production-Ready RAG Infrastructure for AI Agents Build sophisticated AI agents with enterprise-grade RAG capabilities in minutes, not months. The Sensay API provides the complete infrastructure for creating context-aware, knowledge-grounded AI agents that learn from your data and scale with your needs. Core Infrastructure Advanced RAG Pipeline Multi-modal ingestion: Process text,…
Sensay API endpoints
| Method | Endpoint | Description |
|---|---|---|
| v1 > api-keys > invites > {code} > redeem | ||
| POST |
redeemAnApiKeyInvitation /v1/api-keys/invites/{code}/redeem |
If you have an invitation code, you can redeem it to create an Organization and an API key associated with it. |
| v1 > replicas | ||
| GET |
listReplicas /v1/replicas |
List replicas with pagination with optional filtering. Only Replicas that are public or belong to the authenticated user are returned. |
| POST |
createAReplica /v1/replicas |
Creates a new replica. |
| v1 > replicas > {replicaUUID} | ||
| PUT |
updatesAReplica /v1/replicas/{replicaUUID} |
Updates an existing replica. |
| GET |
getAReplica /v1/replicas/{replicaUUID} |
Get an existing replica. |
| DELETE |
deleteAReplica /v1/replicas/{replicaUUID} |
Deletes a replica by UUID. |
| v1 > replicas > {replicaUUID} > chat > history | ||
| POST |
createAChatHistoryEntry /v1/replicas/{replicaUUID}/chat/history |
Save chat history items of a Replica belonging to the logged in user. |
| GET |
getChatHistory /v1/replicas/{replicaUUID}/chat/history |
List chat history items of a Replica belonging to the logged in user. |
| v1 > replicas > {replicaUUID} > chat > history > telegram | ||
| POST |
createATelegramChatHistoryEntry /v1/replicas/{replicaUUID}/chat/history/telegram |
Save chat history items of a Replica belonging to the logged in user. |
| GET |
getTelegramChatHistory /v1/replicas/{replicaUUID}/chat/history/telegram |
List telegram chat history items of a Replica belonging to the logged in user. |
| v1 > replicas > {replicaUUID} > chat > history > discord | ||
| GET |
getDiscordChatHistory /v1/replicas/{replicaUUID}/chat/history/discord |
List discord chat history items of a Replica belonging to the logged in user. |
| v1 > replicas > {replicaUUID} > chat > history > web | ||
| GET |
getWebChatHistory /v1/replicas/{replicaUUID}/chat/history/web |
List web chat history items of a Replica belonging to the logged in user. |
| v1 > replicas > {replicaUUID} > chat > history > embed | ||
| GET |
getEmbedChatHistory /v1/replicas/{replicaUUID}/chat/history/embed |
List embed chat history items of a Replica belonging to the logged in user. |
| v1 > replicas > {replicaUUID} > chat > completions | ||
| POST |
generateACompletion /v1/replicas/{replicaUUID}/chat/completions |
Ask for a completion and stores the prompt in the chat history. Replica chat supports two response formats: streamed and JSON. To switch between these formats, use the 'Accept'… |
| v1 > replicas > {replicaUUID} > chat > completions > telegram | ||
| POST |
generateATelegramCompletion /v1/replicas/{replicaUUID}/chat/completions/telegram |
Ask for a completion and stores the prompt in the chat history. Replica chat supports two response formats: streamed and JSON. To switch between these formats, use the 'Accept'… |
| v1 > replicas > {replicaUUID} > integrations > telegram | ||
| DELETE |
deleteAReplicaTelegramIntegration /v1/replicas/{replicaUUID}/integrations/telegram |
Removes a replica Telegram integration. |
| POST |
createAReplicaTelegramIntegration /v1/replicas/{replicaUUID}/integrations/telegram |
Integrates a replica to Telegram. The default Sensay Telegram integration will run a bot for you until you delete the integration. |
| v1 > replicas > {replicaUUID} > conversations | ||
| GET |
listReplicasConversations /v1/replicas/{replicaUUID}/conversations |
List of replica's conversations with pagination and sorting. |
| v1 > replicas > {replicaUUID} > conversations > {conversationUUID} | ||
| GET |
getConversationDetails /v1/replicas/{replicaUUID}/conversations/{conversationUUID} |
Retrieve details for a specific conversation within a replica. |
| v1 > replicas > {replicaUUID} > conversations > {conversationUUID} > mentions | ||
| GET |
listMentionsInAConversation /v1/replicas/{replicaUUID}/conversations/{conversationUUID}/mentions |
Retrieves mentions of a replica in a specific conversation, together with context surrounding the mention. This endpoint supports cursor-based pagination. Returns most recent… |
| v1 > replicas > {replicaUUID} > conversations > {conversationUUID} > messages | ||
| GET |
listMessagesInAConversation /v1/replicas/{replicaUUID}/conversations/{conversationUUID}/messages |
Retrieves messages in a specific conversation with cursor-based pagination. Messages are sorted chronologically from oldest to newest. Use the `beforeUUID` parameter to get older… |
| v1 > replicas > {replicaUUID} > analytics > conversations > historical | ||
| GET |
getReplicaHistoricalConversationAnalytics /v1/replicas/{replicaUUID}/analytics/conversations/historical |
Returns cumulative conversation count for the last 30 days, up to and including today. |
| v1 > replicas > {replicaUUID} > analytics > conversations > sources | ||
| GET |
getReplicaSourceAnalytics /v1/replicas/{replicaUUID}/analytics/conversations/sources |
Returns interaction counts by source for the replica. |
| v1 > replicas > {replicaUUID} > knowledge-base | ||
| POST |
createAKnowledgeBaseEntry /v1/replicas/{replicaUUID}/knowledge-base |
Creates a new knowledge base entry for a replica based on text, file, URL, or Youtube Videos. For YouTube playlists, the system will automatically create separate entries for… |
| GET |
listAllKnowledgeBaseEntries /v1/replicas/{replicaUUID}/knowledge-base |
Returns a list of all knowledge base entries belonging to a replica. This endpoint allows you to view all your training data in one place, with optional filtering by status or… |
| v1 > replicas > {replicaUUID} > knowledge-base > {knowledgeBaseID} | ||
| GET |
getKnowledgeBaseEntryById /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID} |
Retrieves detailed information about a specific knowledge base entry using its ID. This endpoint returns the complete entry data including its type, status, content, and… |
| DELETE |
deleteKnowledgeBaseEntryById /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID} |
Permanently removes a specific knowledge base entry and its associated vector database entry. Use this endpoint when you need to remove outdated or incorrect training data from… |
| PATCH |
updateKnowledgeBaseEntry /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID} |
Updates a knowledge base entry with training content. This is the second step in the training process after creating an entry. You can provide "rawText" which is the content you… |
| v1 > experimental > replicas > {replicaUUID} > chat > completions | ||
| POST |
generateACompletionOpenAiCompatibleNonStreaming /v1/experimental/replicas/{replicaUUID}/chat/completions |
> warn > Limited [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat/create) compatibility. > Supports basic chat completion with standard message… |
| v1 > users | ||
| POST |
createAUser /v1/users |
Creates a new user. |
| v1 > users > me | ||
| GET |
getTheCurrentUser /v1/users/me |
Returns information about the current user. |
| PUT |
updateTheCurrentUser /v1/users/me |
Update the currently logged in user. |
| DELETE |
deleteTheCurrentUser /v1/users/me |
This endpoint permanently deletes the currently authenticated user account, including all associated data. After deletion, the account cannot be recovered. |
| v1 > users > me > usage | ||
| GET |
getUsageMetrics /v1/users/me/usage |
Returns usage metrics including total conversations and knowledge base entries across all replicas owned by the authenticated user. |
| v1 > users > {userID} | ||
| GET |
getAUserById /v1/users/{userID} |
Returns information about the user with the specified ID. |
| v1 > knowledge-base > file-types | ||
| GET |
getSupportedFileTypes /v1/knowledge-base/file-types |
Returns a list of all supported file types and MIME types for knowledge base entries. This endpoint provides information about which file formats can be uploaded to the knowledge… |
Sensay API pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|