# 
Syft Space
[](https://www.python.org/downloads/)
[](https://nodejs.org/)
[](https://fastapi.tiangolo.com/)
[](https://vuejs.org/)
[](LICENSE)
> **Make your knowledge queryable without giving it up.** Syft Space lets you create AI-powered endpoints that others can query while your data stays under your control.
## What is Syft Space?
A Syft Space is a decentralized node operated by anyone with knowledge to share: a publisher, a research lab, a journalist, an institution, or just an individual.
You add your documents, connect an AI model, and create endpoints that others can query. You control who gets access, what they can ask, and whether they pay.
**Key Benefits:**
- **๐ Privacy-First**: Your data never leaves your control
- **๐ฏ Selective Sharing**: Share insights, not raw data
- **๐ฐ Monetization**: Set your own pricing and access rules
- **๐ AI-Powered**: Make any document collection searchable with AI
- **๐ Decentralized**: Part of a growing network while maintaining independence
Think of it like creating an API for your knowledge - others get answers without seeing your source material.
## ๐๏ธ Architecture
Syft Space is a full-stack application that creates a bridge between your private data and AI models, allowing controlled access through secure endpoints.
**Core Architecture:**
- **Frontend**: Vue 3 web interface for management and configuration
- **Backend**: FastAPI server handling requests, policies, and data processing
- **Vector Databases**: Local or remote databases (Weaviate, Qdrant, ChromaDB) for document indexing
- **AI Models**: Integration with OpenAI, Anthropic, Ollama, vLLM, and other providers
- **SyftHub Integration**: Optional publishing to the decentralized knowledge network
The system automatically provisions Docker containers for local vector databases and provides a unified API for querying across different data sources and AI models.
## How It Works
Build your knowledge hub with four core components:
### ๐ **Datasets**
Upload documents or connect vector databases. Files are automatically indexed for AI search.
### ๐ค **Models**
Connect OpenAI, Anthropic, Ollama, vLLM, or any OpenAI-compatible provider.
### ๐ **Endpoints**
Combine datasets and models into queryable RAG endpoints anyone can use.
### ๐ก๏ธ **Policies**
Control access, set rate limits, and configure pricing for your endpoints.
```
[Your Data] + [AI Model] โ [Queryable Endpoint] + [Your Rules] = [Controlled Knowledge Sharing]
```
## Use Cases
- **๐ Publishers & Creators** โ Make your content AI-queryable for your audience while maintaining attribution and control
- **๐ Researchers** โ Turn your papers and notes into a searchable knowledge assistant that others can query
- **๐ข Organizations** โ Build AI-powered customer support from your documentation without exposing internal details
- **๐ฅ Teams** โ Create searchable knowledge hubs from scattered wikis, docs, and guides
- **๐ก Data Monetization** โ Share valuable insights from your data without exposing the underlying information
## ๐ Getting Started
### Step 1: Install Syft Space
**Prerequisites:** 4GB RAM minimum, 8GB recommended
Choose your installation method:
#### Option A: Desktop App (Recommended for beginners)
- **macOS**: Download `.dmg` from [Releases](https://github.com/OpenMined/syft-space/releases)
- **Linux**: Download `.AppImage`, `.deb`, or `.rpm` from [Releases](https://github.com/OpenMined/syft-space/releases)
**Features:** One-click setup, system tray integration, auto-updates
#### Option B: Docker (Production ready)
```bash
docker run -d \
--name syft-space \
--restart unless-stopped \
-p 8080:8080 \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /dev/null:/root/.docker/config.json \
-v syft-space-data:/data \
ghcr.io/openmined/syft-space:latest
```
#### Option C: From Source (Development)
```bash
git clone https://github.com/OpenMined/syft-space.git
cd syft-space
./run.sh
```
### Step 2: Register Your Account
1. Open [http://localhost:8080](http://localhost:8080) in your browser
2. Click **"Register"** and create your account
3. **Important**: Add your developer token (for local) or public IP (for VM deployment)
### Step 3: Add Your Data
1. Go to **Datasets** โ **Add Dataset**
2. Upload documents, files, or connect a vector database
3. Wait for automatic processing and indexing
### Step 4: Create an Endpoint
1. Go to **Endpoints** โ **Add Endpoint**
2. Select your dataset and choose an AI model
3. Configure output type (search, AI summary, or both)
4. Set access policies and pricing
### Step 5: Test & Publish
1. Test your endpoint with the built-in query interface
2. Click **Publish** โ Choose visibility (Organization or Public)
3. Your endpoint is now live at [syfthub.openmined.org](https://syfthub.openmined.org)
**Example API Query:**
```bash
curl -X POST http://localhost:8080/api/v1/endpoints/my-docs/query \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your-token" \
-d '{"messages": [{"role": "user", "content": "What are the main topics?"}]}'
```
## ๐ Developer Token
**Required for local deployments only.** If you're running Syft Space locally (not on a VM with public IP), you'll need a developer token to publish endpoints.
| Scenario | Token Required? |
|----------|----------------|
| ๐ Local machine | โ
Yes - get from OpenMined |
| โ๏ธ Cloud VM/Server | โ No - uses public IP |
| ๐งช Local development only | โ No - for testing only |
**Getting a token:** Contact OpenMined directly (currently in beta)
**Configure:** During onboarding or in Settings โ Network
## โจ Key Features
- **๐๏ธ Multi-database support**: Weaviate, Qdrant, ChromaDB, or remote data sources
- **๐ค Multi-model support**: OpenAI, Anthropic, vLLM, Ollama, and other providers
- **โ๏ธ Auto-provisioning**: Automatically manages Docker containers for local databases
- **๐ป Desktop & web interface**: Run it as an app or deploy as a service
- **๐ Usage analytics**: Monitor costs, tokens, and performance
- **๐ Marketplace integration**: Publish to SyftHub for discovery
## ๐ Project Structure
```
syft-space/
โโโ packages/
โโโ spaces/ # the Syft Space package
โโโ backend/ # Python FastAPI server
โ โโโ syft_space/ # Main application code
โโโ frontend/ # Vue 3 web interface
โโโ docs/ # Documentation
โโโ Dockerfile # Container build
โโโ docker-compose.yml
```
## ๐ Documentation
- **[Quick Start](http://syft.docs.openmined.org/quickstart)** โ Get started in 3 steps: add data, create endpoint, publish
- **[Introduction](http://syft.docs.openmined.org/space)** โ Understand the concepts
- **[Components Overview](http://syft.docs.openmined.org/space/components/overview)** โ Datasets, models, endpoints, and policies
- **[API Reference](http://syft.docs.openmined.org/space/api)** โ REST API documentation
- **[Installation Guide](http://syft.docs.openmined.org/installation)** โ Complete setup instructions
### Component Guides
- [Datasets](http://syft.docs.openmined.org/space/components/datasets) โ Managing your data sources
- [Models](http://syft.docs.openmined.org/space/components/models) โ AI providers and configuration
- [Endpoints](http://syft.docs.openmined.org/space/components/endpoints) โ Queryable RAG services
- [Policies](http://syft.docs.openmined.org/space/components/policies) โ Access control and rate limiting
**Interactive API docs:** [http://localhost:8080/docs](http://localhost:8080/docs) (when running locally)
## ๐ Part of the Syft Network
A Space connects to **[SyftHub](https://syfthub.openmined.org)** โ a decentralized registry where knowledge providers meet knowledge seekers.
**How it works:**
- ๐ **Discovery**: Others find your published endpoints through SyftHub
- ๐ **Querying**: Users can search and query across multiple Spaces
- ๐ **Attribution**: Every contribution is tracked and credited automatically
- ๐๏ธ **Open Architecture**: Built on open protocols โ no single point of control
The network grows stronger as more Spaces join, but each Space maintains full autonomy over its data and policies.
## ๐ค Contributing
We welcome contributions! Here's how to get started:
1. **Fork the repository** and clone it locally
2. **Set up development environment** (see [Development Guide](http://syft.docs.openmined.org))
3. **Create a feature branch** for your changes
4. **Submit a pull request** with a clear description
**Development setup:**
```bash
git clone https://github.com/your-fork/syft-space.git
cd syft-space
./run.sh
```
See the [Development Documentation](http://syft.docs.openmined.org) for detailed setup and contribution guidelines.
## ๐ License
This project is part of the OpenMined ecosystem and is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
---
Built with โค๏ธ by the OpenMined community
Making AI safer through privacy-preserving technology