OpenRelay Python SDK

The official Python SDK for the OpenRelay API.

Installation

pip install openrelay-sdk

The package imports as openrelay. The unrelated openrelay distribution on PyPI also provides a top-level openrelay module, so install openrelay-sdk, and do not install both into the same environment.

From a checkout of this repository: pip install ./sdks/python.

Quick Start

import openrelay

client = openrelay.Client(api_key="or_your_api_key")

# List available GPUs
gpus = client.gpus.list()

# Create a VM
vm = client.vms.create(
    name="dev-box",
    ssh_key_ids=["your-ssh-key-id"],
    gpu_type="rtx-4090",
    gpu_count=1,
    disk_size_gb=100,
)

# Wait for it to be ready
vm = client.vms.wait_for_status(vm.id)
print(f"VM running at: {vm.endpoint_url}")

Async Usage

import asyncio
import openrelay

async def main():
    async with openrelay.AsyncClient(api_key="or_your_api_key") as client:
        vm = await client.vms.get("your-vm-id")
        print(vm.status)

asyncio.run(main())

Configuration

The client accepts these parameters:

The orl CLI reads the same two variables.

License

MIT