Python Quickstart

pip install hx-sdk

export HX_API_KEY="your-api-key"

from hx import Client

client = Client()

# Org, workspace, environment are extracted from your API key
print(client.org_id)
print(client.workspace_id)
print(client.environment_id)

results = client.knowledge.search(
    store_id="ks-your-store-id",
    query="What is Hexel Studio?",
    top_k=5
)

for result in results["results"]:
    print(f"Score: {result['score']}")
    print(f"Text: {result['text']}")

client.memory.add(
    store_id="ms-your-store-id",
    user_id="user_123",
    messages=[
        {"role": "user", "content": "My name is Alex."}
    ],
    metadata={"type": "identity"}
)

memories = client.memory.search(
    store_id="ms-your-store-id",
    query="What is my name?",
    user_id="user_123",
    top_k=10
)

for mem in memories["results"]:
    print(f"Memory: {mem['memory']}")
    print(f"Score: {mem['score']}")

all_memories = client.memory.list(
    store_id="ms-your-store-id",
    user_id="user_123"
)

client.memory.update(
    store_id="ms-your-store-id",
    memory_id="mem_abc123",
    data="Updated memory content"
)

client.memory.delete(
    store_id="ms-your-store-id",
    memory_id="mem_abc123"
)

history = client.memory.history(
    store_id="ms-your-store-id",
    memory_id="mem_abc123"
)

from hx import Client
from hx.exceptions import HXError, AuthenticationError

client = Client()

try:
    results = client.knowledge.search(
        store_id="ks-your-store-id",
        query="search query",
        top_k=5
    )
except AuthenticationError:
    print("Invalid API key")
except HXError as e:
    print(f"API error: {e}")