SynapseX Quickstart Guide

Get up and running with SynapseX in just 5 minutes. This guide covers account creation, API key setup, and making your first AI-powered request.

Prerequisites

• Python 3.9+ (or any HTTP client)
• Internet connection

Step 1: Create Your Account

1. Visit synapsex.ai
2. Click "Get Started"
3. Complete registration
4. Verify your email
5. Access your dashboard

Free Trial Included

Every new account includes:

• 1,000 API calls/month
• 10,000 tokens/day
• Classic reranking included
• Access to base models

Step 2: Get Your API Key

1. Log into your SynapseX Dashboard
2. Navigate to Settings → API Keys
3. Click "Generate New Key"
4. Copy and save your key securely

Your API key format: sk-synapsex-xxxxxxxxxxxx

Security Notice

Your API key provides full access to your account. Never share it or commit it to version control.

Step 3: Make Your First Call

SynapseX is OpenAI-compatible, so you can use existing SDKs:

Using Python (OpenAI SDK)

from openai import OpenAI

client = OpenAI(
    api_key="sk-synapsex-your-key",
    base_url="https://api.synapsex.ai/v1"
)

response = client.chat.completions.create(
    model="synapsex-chat",
    messages=[
        {"role": "user", "content": "What is quantum computing?"}
    ],
    temperature=0.7,
    max_tokens=512
)

print(response.choices[0].message.content)

Using cURL

curl -X POST https://api.synapsex.ai/v1/chat/completions \
  -H "Authorization: Bearer sk-synapsex-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "synapsex-chat",
    "messages": [{"role": "user", "content": "What is quantum computing?"}],
    "temperature": 0.7,
    "max_tokens": 512
  }'

Using JavaScript

const response = await fetch('https://api.synapsex.ai/v1/chat/completions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk-synapsex-your-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    model: 'synapsex-chat',
    messages: [{ role: 'user', content: 'What is quantum computing?' }],
    temperature: 0.7,
    max_tokens: 512
  })
});

const data = await response.json();
console.log(data.choices[0].message.content);

Step 4: Enable Quantum Reranking

Enhance response quality with quantum-powered selection:

response = client.chat.completions.create(
    model="synapsex-chat",
    messages=[
        {"role": "user", "content": "Explain the benefits of solar energy"}
    ],
    extra_body={
        "use_rerank": "quantum_cpu",  # Options: "classic", "quantum_cpu", "quantum_gpu"
        "rerank_k": 4  # Number of candidate responses
    }
)

# Access reranking metadata
print(f"Selected from {response.meta.candidates} candidates")
print(f"Rerank tier: {response.meta.rerank_tier}")
print(f"Quality score: {response.meta.quality_score}")

Reranking Tiers

Tier	Setting	Latency	Best For
Classic	"classic"	+5ms	Low-latency apps
Quantum CPU	"quantum_cpu"	+50ms	Balanced quality
Quantum GPU	"quantum_gpu"	+100ms	Maximum quality

Step 5: Stream Responses

Enable streaming for real-time output:

stream = client.chat.completions.create(
    model="synapsex-chat",
    messages=[
        {"role": "user", "content": "Write a short story about AI"}
    ],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

Step 6: Use Multi-Tenant Features

If you're building a B2B application, use tenant isolation:

response = client.chat.completions.create(
    model="synapsex-chat",
    messages=[
        {"role": "user", "content": "What medications interact with aspirin?"}
    ],
    extra_headers={
        "X-Tenant-ID": "farmacia_santa_casa"
    }
)

Each tenant gets:

• Isolated data and context
• Custom LoRA adapters (if trained)
• Separate rate limits
• Usage tracking

Available Models

Model	Description	Context	Best For
synapsex-chat	General purpose	8K	Chat, Q&A
synapsex-chat-32k	Extended context	32K	Long documents
synapsex-instruct	Instruction-tuned	8K	Tasks, commands
synapsex-code	Code generation	16K	Programming

Next Steps

Core Features

• API Reference - Complete endpoint documentation
• Quantum Reranking - Deep dive into QAOA
• Embeddings - Vector embeddings for RAG

Advanced Features

• Training - Fine-tune models with your data
• Proxy Mode - Gateway for external LLMs
• Multi-Tenancy - B2B customer management

Integration

• QCOS Integration - Quantum computing workflows
• RAG Setup - Document retrieval augmentation

Troubleshooting

Common Issues

"Invalid API Key"

{"error": {"code": "UNAUTHORIZED", "message": "Invalid API key"}}

Solution: Verify your API key in the dashboard. Ensure no extra whitespace.

"Rate Limit Exceeded"

{"error": {"code": "RATE_LIMITED", "message": "Rate limit exceeded"}}

Solution: Wait for rate limit reset or upgrade your plan.

"Model Not Found"

{"error": {"code": "MODEL_NOT_FOUND", "message": "Model 'xxx' not found"}}

Solution: Use a valid model name. See Available Models.

Getting Help

• 📧 Email: support@softquantus.com
• 💬 Discord: discord.gg/softquantus
• 📚 Documentation: docs.softquantus.com