Skip to content

Client

Sync Client

python
from axonpush import AxonPush

client = AxonPush(
    api_key="ak_...",
    tenant_id="1",
    base_url="https://api.axonpush.xyz",
    timeout=30.0,  # optional, default 30s
)

# Use the client
event = client.events.publish(...)

# Close when done
client.close()

Context Manager

python
with AxonPush(api_key="ak_...", tenant_id="1", base_url="https://api.axonpush.xyz") as client:
    client.events.publish(...)
# Automatically closed

Async Client

python
from axonpush import AsyncAxonPush

async with AsyncAxonPush(
    api_key="ak_...",
    tenant_id="1",
    base_url="https://api.axonpush.xyz",
) as client:
    event = await client.events.publish(...)

Required for OpenAI Agents SDK integration and any async Python code.

Constructor Parameters

ParameterTypeRequiredDefaultDescription
api_keystrYesYour AxonPush API key
tenant_idstrYesOrganization/tenant ID
base_urlstrYesAPI base URL
timeoutfloatNo30.0HTTP request timeout in seconds

Loading from Environment

python
import os
from axonpush import AxonPush

client = AxonPush(
    api_key=os.environ["AXONPUSH_API_KEY"],
    tenant_id=os.environ["AXONPUSH_TENANT_ID"],
    base_url=os.environ.get("AXONPUSH_BASE_URL", "https://api.axonpush.xyz"),
)