Skip to main content

IndexSDK Overview

Welcome to IndexSDK! IndexSDK is a comprehensive SDK that enables you to integrate powerful AI conversation capabilities into your applications. This documentation will guide you through everything you can do with IndexSDK.

What is IndexSDK?​

IndexSDK provides a robust API for building AI-powered conversational experiences. It offers a multi-tenant architecture that allows you to create, manage, and interact with conversation threads between users and AI agents.

Key Capabilities​

Authentication & Security​

IndexSDK provides secure authentication using client credentials flow:

  • Client Credentials Authentication: Authenticate your application using client_id and client_secret
  • Multi-Tenant Support: Each tenant is identified by a domain (group_name) for data isolation
  • Auth Tokens: Generate secure tokens that contain user identity information for authenticated API requests
  • Domain-Based Isolation: Ensure user data is properly isolated per tenant/organization

Conversations Management​

Create and manage AI-powered conversations:

  • Create Conversations: Initialize new conversation threads with user context
  • Manage Context: Store and update user information and metadata throughout conversations
  • Greeting Messages: Automatically generate personalized greeting messages based on user context
  • Conversation Lifecycle: Full CRUD operations for conversations including deletion

Multi-Tenant Architecture​

IndexSDK is built on a domain-based multi-tenant architecture:

  • Tenant Isolation: Each tenant (identified by domain/group_name) has isolated data
  • Scalable: Support multiple organizations and groups within a single system
  • Permission Management: Manage permissions and access control per domain

Getting Started​

To get started with IndexSDK, follow these steps:

  1. Authenticate: Start by setting up authentication using the Authentication Overview
  2. Create Conversations: Learn how to create and manage conversations in the Conversations Overview
  3. Explore APIs: Dive into the detailed API references for each feature

Architecture Overview​

Next Steps​