Python SDK

pip install hyphaedb

import asyncio

from hyphaedb import HyphaeClient, CellInput, CellType, RecallQuery


async def main() -> None:
    # auth is the whole hyk_... key; it rides every RPC as x-hyphae-key and is never parsed.
    client = await HyphaeClient.connect("localhost:50051", "hyk_your_key_here")
    await client.start_session("my-agent")  # opens the live inbox stream

    node_id = await client.store(
        CellInput(cell_type=CellType.DECISION, content="We ship on Friday", salience=0.9)
    )
    print("stored", node_id)

    hits = await client.recall(RecallQuery(text="ship", k=5))  # cache-first, server on miss
    for hit in hits:
        print(hit.score, hit.from_cache, hit.content)

    async for item in client.inbox():  # deduped gossip deliveries, live
        print("delivered", item.delivery.diff_id)
        break

    await client.close()


asyncio.run(main())

await HyphaeClient.connect(
    endpoint: str,
    auth: str,
    config: ClientConfig | None = None,
) -> HyphaeClient

await client.store(cell: CellInput) -> str

await client.recall(query: RecallQuery) -> list[RecallHit]

await client.start_session(agent_id: str) -> Session

await client.place_beacon(interest: str) -> str

client.inbox() -> AsyncIterator[InboxItem]

await client.close() -> None

CellInput(
    cell_type: CellType,
    content: str,
    scene_id: str | None = None,
    salience: float = 0.5,
)

RecallQuery(
    text: str,
    k: int = 0,                       # 0 ⇒ use ClientConfig.recall_default_k
    cell_types: list[CellType] | None = None,
    scene_id: str | None = None,
    include_inbox: bool = True,
)

RecallHit(node_id: str, content: str, cell_type: CellType, score: float, from_cache: bool)