Sandbox Mode

How It Works

Sandbox keys use the rk_test_ prefix and route all requests to an isolated environment. The Rekall API automatically detects the key type and directs traffic accordingly.

Creating Sandbox Keys

Create sandbox keys in your dashboard settings by selecting "Sandbox" as the environment when creating a new API key. Sandbox keys support the same scopes as production keys.

# Sandbox key (testing)
REKALL_API_KEY=rk_test_abc123def456ghi789

# Production key (live data)
REKALL_API_KEY=rk_live_xyz789abc123def456

import Rekall from '@rekall/sdk';

// Sandbox client - automatically detected from key prefix
const sandbox = new Rekall({
  apiKey: process.env.REKALL_SANDBOX_KEY, // rk_test_...
});

// Production client
const production = new Rekall({
  apiKey: process.env.REKALL_API_KEY, // rk_live_...
});

// Both use the same API, different isolated environments
const testMemory = await sandbox.memories.create({
  type: 'episodic',
  content: 'Test memory for CI pipeline',
});

What's Available

The sandbox environment supports nearly all Rekall features. Your tests can exercise the full memory lifecycle without affecting production.

Limitations

Sandbox mode has intentional limitations to keep the testing environment lightweight and to prevent accidental misuse.

Transitioning to Production

When your integration is tested and ready, transitioning to production requires only swapping the API key. The API surface is identical between environments.

CI Configuration

Store your sandbox key as a CI secret and use it for integration tests.

# .github/workflows/test.yml
name: Integration Tests
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    env:
      REKALL_API_KEY: ${{ secrets.REKALL_SANDBOX_KEY }}
    steps:
      - uses: actions/checkout@v4
      - run: npm install
      - run: npm test