Skip to main content

Official Python SDK for Statewave — Memory OS for AI agents

Project description

statewave-py

Official Python SDK for Statewave — memory runtime for AI agents and applications.

Install

pip install statewave-py

Quick start

from statewave import StatewaveClient

# Basic (no auth)
with StatewaveClient("http://localhost:8100") as sw:
    ...

# With authentication and tenant
with StatewaveClient(
    "http://localhost:8100",
    api_key="your-key",
    tenant_id="acme",
) as sw:
    # Record an episode
    sw.create_episode(
        subject_id="user-42",
        source="support-chat",
        type="conversation",
        payload={
            "messages": [
                {"role": "user", "content": "My name is Alice and I work at Globex."},
                {"role": "assistant", "content": "Welcome Alice!"},
            ]
        },
    )

    # Compile memories (idempotent)
    result = sw.compile_memories("user-42")
    print(f"Created {result.memories_created} memories")

    # Retrieve ranked, token-bounded context
    ctx = sw.get_context("user-42", task="Help with billing", max_tokens=300)
    print(ctx.assembled_context)

    # Batch ingestion (up to 100)
    sw.create_episodes_batch([
        {"subject_id": "user-42", "source": "crm", "type": "note", "payload": {"text": "Prefers email"}},
        {"subject_id": "user-42", "source": "crm", "type": "note", "payload": {"text": "Enterprise plan"}},
    ])

    # Search memories by kind
    facts = sw.search_memories("user-42", kind="profile_fact")
    for m in facts.memories:
        print(f"  [{m.kind}] {m.content}")

    # Semantic search (requires embeddings)
    results = sw.search_memories("user-42", query="billing", semantic=True)

    # List all known subjects
    subjects = sw.list_subjects()
    for s in subjects.subjects:
        print(f"  {s.subject_id}: {s.episode_count} episodes, {s.memory_count} memories")

    # Get timeline
    timeline = sw.get_timeline("user-42")
    print(f"{len(timeline.episodes)} episodes, {len(timeline.memories)} memories")

    # Delete all subject data
    sw.delete_subject("user-42")

Async client

from statewave import AsyncStatewaveClient

async with AsyncStatewaveClient("http://localhost:8100") as sw:
    ctx = await sw.get_context("user-42", task="Help with billing")
    print(ctx.assembled_context)

Error handling

from statewave import StatewaveClient, StatewaveAPIError, StatewaveConnectionError

try:
    sw = StatewaveClient("http://localhost:8100")
    sw.compile_memories("user-42")
except StatewaveAPIError as e:
    print(f"API error [{e.status_code}]: {e.code}{e.message}")
    print(f"Request ID: {e.request_id}")
except StatewaveConnectionError:
    print("Cannot connect to Statewave server")

Models

All response types are Pydantic models with full type hints:

  • Episode — raw interaction record
  • Memory — compiled memory with provenance
  • CompileResult — compilation response
  • SearchResult — search response
  • ContextBundle — assembled context with facts, episodes, provenance
  • Timeline — chronological subject history
  • DeleteResult — deletion confirmation
  • BatchCreateResult — batch ingestion response
  • SubjectSummary — subject with episode/memory counts
  • ListSubjectsResult — paginated subject listing

Running tests

pip install -e ".[dev]"
pytest tests/ -v

License

Apache-2.0

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

statewave_py-0.4.3.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

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

statewave_py-0.4.3-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file statewave_py-0.4.3.tar.gz.

File metadata

  • Download URL: statewave_py-0.4.3.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for statewave_py-0.4.3.tar.gz
Algorithm Hash digest
SHA256 f9425228c5fb7aadeb316101e38f9fd0e4e18750679a367caf793d117d0fe71e
MD5 eba498032b49f65d2140444e8a7a39c2
BLAKE2b-256 9832397fa17192f9ede5e6185c207306674e27ae8b68511d0a5b89d65c2469cc

See more details on using hashes here.

Provenance

The following attestation bundles were made for statewave_py-0.4.3.tar.gz:

Publisher: release.yml on smaramwbc/statewave-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file statewave_py-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: statewave_py-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for statewave_py-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ae30221a4eb25cfc8b20cb868c4b030e221cf5594850a4c63ebb15cd0c5d4ab4
MD5 00ace6c24a5f40c5e36ac72e98db7099
BLAKE2b-256 d683b0f58010300666b9339a705ab6b5c29c71a599c57ddc62f4bb89732e5151

See more details on using hashes here.

Provenance

The following attestation bundles were made for statewave_py-0.4.3-py3-none-any.whl:

Publisher: release.yml on smaramwbc/statewave-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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