API Reference

Python SDK

The Python SDK wraps hosted SQL, sessions, capabilities, proposals, and backups.

Overview

Use the Python SDK when it is available in your beta environment.

The SDK is designed for agent/RAG developers who start in Python.

The core shape is stable: connect, set trusted session values, run SQL, invoke capabilities, and inspect proposal/evidence lookup records.

Developer notes

Keep API keys in environment variables or your server-side secret store.
Set trusted session values before invoking capabilities.
Treat proposal approval and commit as privileged actions.
Pin SDK versions for beta apps so breaking changes are deliberate.

Install and connect

Python

from synapsor import Synapsor

# In production, load the API key from an environment variable or secret manager.
db = Synapsor("https://synapsor.ai", api_key="syn_...")
# Session values are trusted app/backend values, not model-generated text.
db.set_session({"tenant_id": "acme", "principal": "agent_1"})
print(db.query("SELECT 1;"))

Examples

bash

python -m pip install synapsor