Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.velahq.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Constructor options

Both sync and async clients accept the same options: 
VelaManagementClient(
    client_secret: str,
    *,
    base_url: str = "https://api.vela.dev",
    timeout: float = 30.0,
)

​
Custom base URL

client = VelaManagementClient(
    os.environ["VELA_CLIENT_SECRET"],
    base_url="http://localhost:3000",
)

​
Custom timeout

client = VelaIngestClient(
    os.environ["VELA_API_KEY"],
    timeout=5.0,  # 5 seconds
)

​
Context managers

Both sync and async clients support context managers for clean resource management: 
# Sync
with VelaManagementClient(secret) as client:
    apps = client.apps.list()
# Connection is closed automatically

# Async
async with AsyncVelaManagementClient(secret) as client:
    apps = await client.apps.list()
You can also manage the lifecycle manually: 
client = VelaManagementClient(secret)
apps = client.apps.list()
client.close()  # or await client.aclose() for async