Introduction to the SDK

Welcome to the Qelos SDK documentation. This section provides an overview of the SDK, including its core features, installation, and basic usage. Whether you are a developer or an administrator, this guide will help you get started with the SDK.

Key Features

Authentication

Secure user authentication with OAuth and session-based options. Includes automatic token refresh and session management.

Token Management

Automatic token refresh functionality to maintain user sessions without interruption.

Blueprints

Create and manage data models with powerful blueprint operations for your application.

Configurations

Manage application configurations with easy-to-use APIs for retrieval and updates.

Plugins

Extend functionality with plugins to connect to other micro-SaaS platforms.

User Management

Comprehensive APIs for managing users, permissions, and roles.

Workspace Management

Multi-tenant support with workspace management capabilities.

AI Operations

Powerful AI chat completions, thread management, and streaming capabilities for intelligent applications.

Error Handling

Robust error handling patterns and best practices for reliable applications.

Getting Started

Installation

To install the Qelos SDK, use your preferred package manager:

npm install @qelos/sdk
# or
yarn add @qelos/sdk
# or
pnpm add @qelos/sdk

Basic Setup

import QelosSDK from '@qelos/sdk';

// Initialize the SDK
const sdk = new QelosSDK({
  appUrl: 'https://your-qelos-app.com',
  fetch: globalThis.fetch, // Required: provide fetch implementation
  forceRefresh: true, // Enable automatic token refresh
});

// Authenticate the user
await sdk.authentication.oAuthSignin({
  username: 'user@example.com',
  password: 'password'
});

// Now you can use the SDK to interact with Qelos
const workspaces = await sdk.workspaces.getList();
const userProfile = await sdk.authentication.getLoggedInUser();

// Use AI capabilities
const thread = await sdk.ai.createThread({
  integration: 'your-ai-integration-id',
  title: 'Customer Support Chat'
});

const response = await sdk.ai.chat('your-ai-integration-id', {
  messages: [{ role: 'user', content: 'Hello!' }]
});

Developer Resources

Authentication Tutorial

Learn how to implement a complete authentication flow in your application.

TypeScript Types

Comprehensive guide to TypeScript types in the SDK for better development experience.

Troubleshooting

Solutions for common issues and debugging techniques.

SDK Documentation

The Qelos SDK is organized into several modules, each providing specific functionality for your SaaS application. Below is a comprehensive list of all available SDK modules and their documentation:

Reference

• SDK Reference - Single-stop reference for every public module: signatures, parameters, return types, examples, and the query builder cheat sheet

Core SDK

• Core Functionality - SDK initialization, custom headers, and base features
• Token Refresh - Automatic token refresh functionality
• Error Handling - Error handling patterns and best practices

User Management

• Authentication - User authentication and session management
• Managing Users - User management APIs

Multi-tenancy

• Managing Workspaces - Multi-tenant workspace operations
• Managing Invites - Workspace invitation handling

Data & Content

• Blueprints Operations - Data model definition and entity management
• Managing Blocks - Content block operations
• Managing Configurations - Application configuration settings

Extensions

• Managing Plugins - Plugin integration and management

AI & Intelligence

• AI Operations - AI chat completions, thread management, and streaming capabilities

API Reference

Looking for the raw HTTP endpoints instead? See the API Reference for complete REST API documentation. Every SDK method maps directly to an API endpoint, with cross-links between both sections.

About Qelos

Qelos is a SaaS platform developed by Velocitech LTD that enables you to create your own SaaS applications with multi-tenant capabilities. The platform provides a comprehensive set of tools and APIs to build, deploy, and manage your applications efficiently.