Welcome to Unique SDK¶

Unique SDK enables Python developers to access the Unique platform through its public API endpoints, facilitating development of custom integrations, tools, and agents.

Table of Contents¶

Environment Setup¶

Installation - Install and set up the SDK
Configuration - Configure API credentials and settings

Application Types¶

Quickstart Guide - Get started with your first API calls

Standalone Application¶

Standalone applications use the capabilities of the Unique platform but do not interact with users directly via any GUI. Examples include:

Knowledge base management pipelines
Automatic report generation
Batch processing workflows

See the Quickstart Guide for examples of standalone applications.

Event Driven Applications¶

Event-driven applications react to events obtained from the Unique platform. These events can be used to initialize services that interact with the chat, knowledge base, or other platform features.

Webhooks - Receive and handle real-time events from Unique AI
Tutorials - Step-by-step tutorials and guides

Supported Models & LLM Access¶

LLM Models - View available language models for chat completions and other operations
OpenAI Integration - Use OpenAI SDK with Unique's secure API proxy

API Reference¶

The SDK provides access to the following API resources:

Core Resources¶

Content - Manage knowledge base content and documents
Message - Create and manage chat messages
Search - Search the knowledge base
Search String - String-based search operations
Folder - Organize content in folders
Space - Manage conversational spaces and assistants

Advanced Features¶

Chat Completion - Generate chat completions using LLMs
Embeddings - Generate embeddings for text
Short Term Memory - Store temporary data between chat rounds
Agentic Table - Interact with agentic tables

Message Management¶

Message Log - Update execution steps in chat UI
Message Execution - Track long-running message operations
Message Assessment - Evaluate message quality and compliance

User & Access Management¶

User - Manage users and user configurations
Group - Manage user groups and permissions

Utilities¶

Chat History - Load and convert chat history
File I/O - Upload and download files
Sources - Process and merge search sources
Token Management - Manage token usage and limits
Chat in Space - Helper functions for space interactions

Query Language¶

UniqueQL - Advanced query language for filtering metadata

Architecture & Tutorials¶

Architecture Overview - Understand the SDK's architecture and design
Tutorials - Step-by-step tutorials:
Folder Updates - Manage folder configurations and access
Rule-Based Search - Search content using metadata filters
OpenAI Integration - Use OpenAI SDK with Unique API proxy

Next Steps¶

New to Unique SDK? Start with the Installation Guide
Ready to code? Follow the Quickstart Guide
Want to learn? Check out our Tutorials for step-by-step guides
Building integrations? Check out Webhooks for event-driven applications
Need help? Browse the API Reference for detailed documentation