@ragsuite/core
v1.0.0
Published
RAGSuite embed SDK core contract (init, API client, auth)
Readme
@ragsuite/core
Shared RAGSuite mobile embed SDK: init validation, API client, and mobile auth helpers.
Website: www.ragsuite.de
Source: github.com/ragsuite/RAGSuite-SDK
Install
npm install @ragsuite/coreUsed transitively by @ragsuite/react-native. Install the React Native package unless you are building a custom UI on top of the core client.
Credentials
| Surface | Credential |
|---------|------------|
| Mobile / React Native SDK | Project-scoped API key: rgs_live_... or rgs_test_... |
| Web HTML embed | Embed token — do not use as mobile apiKey |
Init
import { validateInitConfig, RAGSuiteClient } from '@ragsuite/core';
const config = validateInitConfig({
projectId: 'YOUR_PROJECT_UUID',
apiKey: 'rgs_live_YOUR_KEY',
endpoint: 'YOUR_API_BASE_URL',
features: ['chat', 'search'],
});
const client = new RAGSuiteClient(config);Exports
| Export | Purpose |
|--------|---------|
| validateInitConfig | Validates and normalizes init config |
| RAGSuiteClient | Chat and search API client |
| buildMobileAuthHeaders | Bearer auth headers for mobile keys |
| formatMobileApiError | User-facing error messages |
| normalizeChatSources | Citation normalization |
| parseWidgetColor | Solid / gradient color parsing |
| formatRelativeTime | Relative message timestamps |
| resolveAvatarUrl | Avatar URL resolution |
Peer dependencies
This package has no peer dependencies. It runs in Node (tests) and React Native (via the init package).
Requirements
- Node.js 18+ for development
- Mobile apps consume this package through
@ragsuite/react-native
License
Copyright 2026 NITSAN. Apache License, Version 2.0.
