Skip to main content

ZizkaDB tells you when your agent stops behaving like itself. Causal lineage, time travel and behavioral baselines for any AI agent.

Project description

zizkadb-sdk

Python SDK for ZizkaDB — the operational database for AI agents.

Setup (managed cloud)

  1. Sign up at db.zizka.ai
  2. Settings → Create API key (zizkadb_live_…; legacy agdb_live_… still works)
  3. Pass the key to the SDK (constructor or ZIZKADB_API_KEY env var)

Install

pip install zizkadb-sdk

Note: There is an unrelated package called agentdb on PyPI. Install zizkadb-sdk. Import: from zizkadb import ZizkaDB.

Scaffold a project

pip install zizkadb-sdk
zizkadb init my-agent --template basic
cd my-agent && cp .env.example .env   # paste your key into ZIZKADB_API_KEY
pip install -r requirements.txt
python agent.py

Templates: basic, openai, langchain, crewai, mcp-cursor.

Quickstart

from zizkadb import ZizkaDB

# Managed cloud — paste your key from db.zizka.ai Settings
db = ZizkaDB("zizkadb_live_xxxx")

# Or use env: export ZIZKADB_API_KEY=zizkadb_live_xxxx
# db = ZizkaDB("zizkadb_live_xxxx")  # same as os.getenv("ZIZKADB_API_KEY")

# Self-hosted — auto-sends local dev key (zizkadb_dev_local)
db = ZizkaDB(host="http://localhost:8000")

async with db:
    result = await db.log(
        agent="my-bot",
        event="tool_call",
        data={"tool": "search", "query": "billing"},
    )
    chain = await db.why(result.event_id)
    chain.print()

Cloud host without an API key raises an error at init (no silent 401s).

Environment variables

Variable Purpose
ZIZKADB_API_KEY Your cloud API key (preferred)
AGENTDB_API_KEY Legacy alias for ZIZKADB_API_KEY
ZIZKADB_HOST Self-hosted API URL
ZIZKADB_TELEMETRY Set false to opt out

Self-host dashboard

  1. docker compose -f infra/docker-compose.yml up -d
  2. NEXT_PUBLIC_API_URL=http://localhost:8000 NEXT_PUBLIC_DEV_MODE=true npm run dev in dashboard/
  3. Open http://localhost:3000/loginOpen my dashboard →
  4. Settings → create a named API key for production

Telemetry opt-out

export ZIZKADB_TELEMETRY=false

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zizkadb_sdk-0.2.3.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zizkadb_sdk-0.2.3-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file zizkadb_sdk-0.2.3.tar.gz.

File metadata

  • Download URL: zizkadb_sdk-0.2.3.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for zizkadb_sdk-0.2.3.tar.gz
Algorithm Hash digest
SHA256 c12dbd1e904afbcf44c92e9bd608314121e8f56b213f07ad390e64866caa596f
MD5 8f3b1d2edfc6f2466bbd48d04ba15236
BLAKE2b-256 194972548a1c1e8ebeba22ce53963ea629b0ccb437f7119cbdb10220c7127033

See more details on using hashes here.

File details

Details for the file zizkadb_sdk-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: zizkadb_sdk-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for zizkadb_sdk-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 709c6b8e44b984c8803f14c7409fe7cb899810bb4ba6148c1197445af093ca9f
MD5 a214199ff9f3d35b42a0370c8d59fdaa
BLAKE2b-256 5c8f98c7a682f32be754519d21da42233ceebd49d575704ebcf4e16cb8a3bf44

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page