Skip to main content

zizkadb-sdk

PyPI: zizkadb-sdk 0.2.6

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

Setup (managed cloud)

  1. Sign up at db.zizka.ai
  2. Dashboard → Create agent (e.g. my-bot) — you get an API key for that agent
  3. Use the same agent name in every db.log() call
  4. Set ZIZKADB_API_KEY (or pass the key to the constructor)

Important: The agent in db.log(agent="...", ...) must match the agent you created in the dashboard. A mismatch returns 403 AgentScopeError.

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

# Key from Dashboard → Settings → API keys → create "my-bot" → copy key
db = ZizkaDB("zizkadb_live_xxxx")

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

Multi-agent apps (one key, many agent names)

If your app logs to different agent ids per user (e.g. conv-alice, conv-bob), create a tenant-wide key in Settings → Tenant-wide API key. Per-agent keys only work for that one agent name.

Errors

Exception Meaning
AuthError Invalid or revoked API key
AgentScopeError Key is for agent A but you logged to agent B
NotFoundError Event or agent not found

Environment variables

Variable Purpose
ZIZKADB_API_KEY Your cloud API key (preferred)
AGENTDB_API_KEY Legacy alias for ZIZKADB_API_KEY
ZIZKADB_AGENT Default agent name (used in templates/examples)
ZIZKADB_HOST Self-hosted API URL
ZIZKADB_TELEMETRY Set false to opt out (anonymous ping after first log())

Self-host dashboard

  1. bash scripts/setup-local.sh (API + dashboard on port 3001)
  2. Open http://localhost:3001/login → Open my dashboard →

Links

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.7.tar.gz (25.4 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.7-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for zizkadb_sdk-0.2.7.tar.gz
Algorithm Hash digest
SHA256 fc653dbf9f79a5c36ad06c6cfef8b56761d1a595849d580ae5421be105dc6632
MD5 b4dc538bd7347e82ec74d6eb584c7dc6
BLAKE2b-256 598b14210bb0452c857fe9aaaaae4fe68e6f07464e455945213a318bb5fe859d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for zizkadb_sdk-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 32a5b3753b74b3c812b6f61d9316961b3101cebaf666027e098a9b3356a814f8
MD5 54ee77b32bc4bd41cfc7424ddcb3cc9c
BLAKE2b-256 d263060c2ede0aae1b593ed829e253c3d14200daf7bbea9f1c55cbe332d4b71a

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.8

2 files

This release

0.2.7 This release

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page