Skip to main content
The vela-sdk package provides sync and async clients for the Vela API using httpx.

​
Features

  • Sync + Async — identical API surface for both modes
  • Context manager support — with and async with for clean resource management
  • Type hints — TypedDict inputs, dataclass responses
  • Single dependency — only httpx

​
Two clients

ClientAuthPurpose
VelaIngestClient / AsyncVelaIngestClientAPI key (vela_live_...)Send events
VelaManagementClient / AsyncVelaManagementClientClient secret (vela_cs_...)Manage apps, schemas, rules
from vela import VelaIngestClient, VelaManagementClient

# Ingest events
with VelaIngestClient(os.environ["VELA_API_KEY"]) as ingest:
    ingest.ingest({"event": "order.placed", "data": {"orderId": "ord_1"}, "level": "info"})

# Manage resources
with VelaManagementClient(os.environ["VELA_CLIENT_SECRET"]) as client:
    apps = client.apps.list()

Installation

Install and set up the SDK.

Ingest Client

Send single and batch events.

Management Client

Manage apps, schemas, and rules.

Error Handling

Handle API errors gracefully.