Installation

Requirements

pip install synapserun

uv add synapserun

npm install @runsynapse/sdk

pnpm add @runsynapse/sdk

The Python package includes the synapse CLI:

synapse --help
synapse sandbox create
synapse sandbox list
synapse template list

Set your API key as an environment variable:

export SYNAPSE_API_KEY="cell_sk_live_..."

Or pass it directly:

from synapse import Cell
cell = Cell(api_key="cell_sk_live_...")

import { Cell } from '@runsynapse/sdk';
const cell = await Cell.create({ apiKey: 'cell_sk_live_...' });

For self-hosted deployments, point the SDK at your gateway:

export SYNAPSE_API_URL="http://your-server:8001"

python -c "from synapse import Cell; print('Synapse SDK ready')"