sciphi cloud setup

Setting Up SciPhi Cloud for Supen

This guide shows you how to set up SciPhi Cloud (hosted R2R) for your Supen knowledge base.

Go to https://app.sciphi.ai
Click “Sign Up” (free tier available, no credit card required)
Verify your email
Log in to the dashboard

Step 2: Get Your API Key

In the SciPhi dashboard, navigate to “Settings” or “API Keys”
Click “Create API Key”
Give it a name (e.g., “Supen Production”)
Copy the API key - you won’t see it again!
Save it securely

Step 3: Configure Supen

For Local Development

Add to your app/.env.local:

# SciPhi Cloud Configuration
R2R_API_URL=https://api.sciphi.ai
R2R_API_KEY=your_api_key_here

For Railway Production

In your Railway dashboard:

Go to your Supen service
Click “Variables”
Add these environment variables:

R2R_API_URL=https://api.sciphi.ai
R2R_API_KEY=your_api_key_here

Click “Deploy”

Step 4: Test the Connection

Run this test to verify everything works:

# Start your Supen dev server
pnpm dev

# In another terminal, test the health endpoint
curl http://localhost:3333/api/knowledge/health

You should see:

{
  "available": true,
  "provider": "R2R",
  "baseUrl": "https://api.sciphi.ai"
}

Step 5: Upload Your First Document

Via API:

curl -X POST http://localhost:3333/api/knowledge/documents \
  -F "file=@/path/to/your/document.pdf" \
  -F "useHiResMode=true"

Via UI:

Go to http://localhost:3333/knowledge (once we build the UI)
Click “Upload Document”
Select your PDF
Enable “Complex Layout Mode” for PDFs with tables/images
Click “Upload”

Step 6: Query Your Knowledge Base

curl -X POST http://localhost:3333/api/knowledge/query \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What is this document about?",
    "limit": 5
  }'

API Endpoints

Once configured, Supen provides these knowledge endpoints:

GET  /api/knowledge/health           # Check R2R availability
GET  /api/knowledge/collections      # List knowledge bases
POST /api/knowledge/collections      # Create knowledge base
GET  /api/knowledge/documents        # List documents
POST /api/knowledge/documents        # Upload document
GET  /api/knowledge/documents/:id    # Get document details
DELETE /api/knowledge/documents/:id  # Delete document
POST /api/knowledge/search           # Search (no generation)
POST /api/knowledge/query            # RAG query (with generation)

Usage with Vibex Agents

Vibex agents can automatically use knowledge context:

import { getKnowledgeService } from "@/lib/r2r";

// In your agent code
const knowledgeService = getKnowledgeService();

// Search for relevant context
const context = await knowledgeService.search(
  userQuery,
  { workspaceId, limit: 5 }
);

// Use context in agent system prompt
const systemPrompt = `
You are an AI assistant with access to the following knowledge:

${context.map(c => c.text).join("

")}

Use this knowledge to answer the user's question accurately.
`;

SciPhi Cloud Limits

Free Tier:

Generous document storage
Standard retrieval speed
Community support

Paid Plans:

Larger document limits
Faster processing
Priority support
Advanced features (knowledge graphs, etc.)

Check https://www.sciphi.ai/pricing for current limits.

Troubleshooting

”Failed to connect to R2R service”

Check:

Is R2R_API_URL set correctly? (should be https://api.sciphi.ai)
Is R2R_API_KEY valid?
Test directly: curl https://api.sciphi.ai/v3/health

Document upload fails