Back API reference

Python SDK

Call Eventium API routes, command flows, webhooks, and public developer utilities from one client.

The Python SDK is the fastest way to script the current Eventium developer surface. Use it for command-bus calls, workspace lifecycle, API keys, webhook management, document intake, OpenAPI discovery, and short-lived sandbox test workflows.

Package name remains titanvx_sdk in this repo. The API base should be https://api.eventium.ai.

Contents

  1. Install
  2. Authentication
  3. How the SDK maps to the stack
  4. Quickstart
  5. Client surface
  6. Sandbox test keys
  7. Webhook operations
  8. Errors

Install

cd sdk/python
python -m pip install -e .

Smoke test:

python -c "from titanvx_sdk import TitanVxClient; print(TitanVxClient(base_url='https://api.eventium.ai'))"

Authentication

Bearer token

Use for signed-in operator workflows and user-owned routes.

client = TitanVxClient(
    base_url="https://api.eventium.ai",
    bearer_token="YOUR_JWT",
)

X-Api-Key

Use for automation, server integrations, and sandbox tests.

client = TitanVxClient(
    base_url="https://api.eventium.ai",
    api_key="TITAN-REPLACE-ME",
)
Session continuity

For Atlas command flows that depend on a stable session, pass session_id so the SDK sends a Session-Id header on every request.

How the SDK maps to the stack

Command bus

Use client.tps.call(...) when you need direct user, agent, domain, zone, bank, memory, or command-bus operations.

Workspace routes

Use the REST namespaces for runtime bindings, files, documents, rules, MCP inventory, skills, and operational flows around Atlas.

Quickstart

from titanvx_sdk import TitanVxClient

client = TitanVxClient(
    base_url="https://api.eventium.ai",
    api_key="TITAN-REPLACE-ME",
    session_id="sandbox-demo-01",
)

resp = client.tps.call(
    service="US_LogOn",
    target={"user": "atlas_handle"},
    vx={"passcode": "12345678"},
)
print(resp)

Example: fetch the combined OpenAPI spec

spec = client.openapi.json()
print(spec["info"]["title"])
print(len(spec.get("paths", {})))

Client surface

client.health.health()
client.health.deps()

client.tps.call(service="AP_Chat", target={...}, content="Hello")

client.api_keys.list()
client.webhooks.events()
client.webhooks.list_endpoints()

client.documents.ingest_text(text="hello")
client.documents.ingest_url(url="https://example.com")

client.rules.list()
client.mcp.list_tools()
client.skills.list()

client.openapi.json()
client.openapi.tps_services()
Current package naming

The Python module is still named titanvx_sdk. Keep that import path until the package is formally renamed in the repo.

Sandbox test keys

The SDK can also call the developer testing key routes exposed on the API host. These are useful when you want a short-lived key for direct experimentation from a local script or notebook. 

client.dev.sandbox_status()

issued = client.dev.create_sandbox_key(
    email="ops@example.com",
    usecase="Validate AP_Chat and webhook delivery flows",
)
print(issued["key"])

The API host also exposes a browser form for issuing, listing, and revoking platform API keys. The current live API returns the raw key on create, lists existing keys by owner/email namespace, and supports revoke by key id.

Webhook operations

events = client.webhooks.events()
print(events)

endpoint = client.webhooks.create_endpoint(
    url="https://example.com/eventium/webhooks",
    events=["quota.threshold.reached", "agent.deployment.updated"],
)

print(endpoint["secret"])  # shown on create / rotate

client.webhooks.test(
    event_type="webhook.test",
    data={"hello": "world"},
)

deliveries = client.webhooks.deliveries(limit=25)
print(deliveries)

Errors

from titanvx_sdk import TitanVxClient, TitanVxHttpError, TitanVxTransportError

client = TitanVxClient(base_url="https://api.eventium.ai", api_key="TITAN-REPLACE-ME")

try:
    print(client.health.health())
except TitanVxHttpError as exc:
    print("HTTP failure:", exc.status_code, exc)
except TitanVxTransportError as exc:
    print("Transport failure:", exc)