Getting Started

Connect with Python

Use the Python SDK for agent and SQL workflows from Python applications.

Overview

The package name is synapsor.

Use database-scoped keys for application code.

Set session context before invoking agent capabilities so hidden bindings are available.

Developer notes

Read SYNAPSOR_API_KEY from environment or a secret manager.
Keep API keys and full hidden session context out of application logs.
Set request timeouts in production HTTP clients.
Handle structured error codes like UNAUTHORIZED, LIMIT_EXCEEDED, and INVALID_REQUEST.

Install

pip

python -m pip install synapsor

Examples

python

import os
from synapsor import Synapsor

db = Synapsor("https://synapsor.ai", api_key=os.environ["SYNAPSOR_API_KEY"])
db.set_session({
    "tenant_id": "acme",
    "principal": "support_agent_17",
})

print(db.query("SELECT 1;"))