/
OP
openrelay
/
OpenRelay API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 2h ago
latest
OpenAPI 3.1.0
2026-08-19
151
183
243.7 KB
c8ee30a7762d
Account
7
get
Current user profile and org memberships
get
Pending org invites addressed to the signed-in user's email
post
Accept a pending org invite (session only)
post
Decline a pending org invite (session only)
patch
Update the caller's profile
post
Create the caller's profile and first org (idempotent)
get
The current principal and the org it acts in
API Keys
3
get
List an org's API keys (no secrets)
post
Create an API key (returns the plaintext once)
delete
Revoke an API key
Batches
4
get
List batches, newest first
post
Create a batch inference job
get
Get a batch by id
post
Cancel a running batch
Billing
8
get
Read the org's auto-recharge policy
put
Set the org's auto-recharge policy
get
Org balance + recent transactions
post
Charge the saved card to top up prepaid balance
get
List saved cards (brand/last4/exp only)
delete
Remove a saved card
post
Set a saved card as the default for charges
post
Start saving a card (Stripe SetupIntent for inline Elements)
Catalog
6
get
GPU availability by model
get
GPU model catalog
get
Locations / regions
get
List models in the OpenRelay catalog (OpenAI-compatible)
get
GPU + CPU pricing
get
VM template catalog
Clusters
8
get
Get a cluster by id
get
Get a cluster with its replicas and GPU model
post
Restart a cluster
post
Scale a cluster's replica count
post
Stop a cluster
post
Terminate a cluster
get
List an org's clusters (cursor-paginated)
post
Create a cluster
Files
5
post
Upload a JSONL input file for the Batch API
post
Mint a signed URL for a direct JSONL upload
get
Get a file's metadata
post
Register a presigned upload after the PUT succeeds
get
Download a file's raw JSONL content
Internal
26
get
Liveness probe (no auth)
get
List serving deployments (platform admin)
post
Create a self-hosted serving deployment (platform admin)
get
Serving deployment detail (platform admin)
delete
Stop a serving deployment (platform admin)
patch
Edit a serving deployment's routing fields in place (platform admin)
post
Drain a serving deployment (platform admin)
post
Set the deployment backend's health (the emergency kill switch)
post
Set one pool member's ranking weight (platform admin)
post
Set the deployment pool's member-selection routing (platform admin)
get
Per-replica runtime view of a serving deployment (platform admin)
post
Take one serving replica out of rotation (platform admin)
post
Return one serving replica to rotation (platform admin)
post
Mint the next generation of a serving deployment (platform admin)
get
List a serving deployment's generation chain (platform admin)
post
Drive a blue/green rollout (platform admin)
post
Set a serving deployment's desired replica count (platform admin)
post
Set the deployment backend's routing weight (platform admin)
get
List serving capacity lanes and their members (platform admin)
get
Pre-deployment checks for a serving spec (platform admin)
get
List serving spec fields and how each may be changed (platform admin)
get
List shadow-mode prompt-capture scopes (platform admin)
put
Create or replace a shadow-mode prompt-capture scope (platform admin)
delete
Immediately turn off a shadow-mode prompt-capture scope (platform admin)
get
List published weights refs (platform admin)
post
Self-enroll a node using a provisioning token (no API key)
Organizations
10
post
Create an organization (caller becomes owner)
get
Get an organization
delete
Delete (soft-delete) an organization (owner only)
patch
Update an organization (owner/admin)
get
List an org's pending invites (owner/admin)
delete
Revoke a pending invite (owner/admin)
get
List an org's members
post
Invite a member by email (owner/admin)
delete
Remove a member (owner/admin)
patch
Update a member's role (owner/admin)
Pods
3
get
List an org's pods (cursor-paginated)
post
Create a pod
get
Live pod GPU capacity and per-class rates
Provider
11
post
Submit a provider application
get
Provider earnings from usage records (+ payout history)
get
List the provider org's nodes (with GPUs + location)
patch
Set a node's operator lifecycle status (drain / maintenance / remove / online)
post
Terminate spot workloads running on a node you own or manage
get
Provider node + token stats
get
Provider status (isProvider + application status)
get
List the org's provisioning tokens (provider only)
post
Generate a provisioning token (owner/admin session, provider org only)
delete
Revoke a provisioning token (owner/admin)
get
One-command node onboarding installer (auth = org API key bearer, OR a pre-minted provisioning token via ?token=)
Registry Credentials
3
get
List an org's registry credentials (no secrets)
post
Create a registry credential (credentials stored encrypted)
delete
Delete a registry credential
Reservations
9
get
List a node's reservations (platform admin)
post
Reserve GPU units on a node for a set of orgs (platform admin)
get
List a node's GPU units, so you can reserve or release them
get
Get one node reservation (platform admin)
patch
Amend a reservation's term, audience, or topology pin (platform admin)
post
End a reservation now (platform admin)
post
Take released GPU units back off the market, evicting spot workloads
post
Release GPU units to the spot market (double sell)
get
What GPU capacity is reserved to this org, and until when
Runners
9
get
List runner pools (with active/queued usage)
post
Create a runner pool
get
GitHub connect URL (OAuth authorize when configured, else App install)
post
List GitHub installations the user can connect (OAuth code exchange)
get
Get a runner pool (with usage)
delete
Delete (or drain) a runner pool
get
List runner jobs for a pool
get
Runner pool job metrics (last 30 days) + cost comparison
post
Resize a runner pool's RAM tier
Snapshots
4
get
List an org's VM snapshots (optionally filtered by source VM)
post
Fork a new VM from a snapshot
delete
Soft-delete a snapshot
post
Create a snapshot of a VM
SSH Keys
3
get
List an org's SSH public keys
post
Add an SSH public key (computes fingerprint)
delete
Delete an SSH public key
Transfers
8
post
Initiate a resource transfer to another org (owner/admin)
get
Pending incoming transfers (enriched)
get
Outgoing transfers, all statuses (enriched)
get
Count of pending incoming transfers
get
Orgs the caller belongs to (for the transfer target dropdown)
post
Accept a pending incoming transfer (target org owner/admin)
post
Cancel a pending outgoing transfer (source org)
post
Reject a pending incoming transfer (target org owner/admin)
Usage
2
get
Current-month usage (cents/hours + per gpuModel-tier breakdown)
get
Per-day spend over a trailing window (compute + inference segments)
VMs
15
get
List an org's VMs (cursor-paginated)
post
Create a VM
get
Get a VM by id
get
Live burn rate, session cost so far, and org runway for a VM
get
Get a VM with its GPU/node/template info and price
post
Reboot a VM
post
Resize a stopped VM's disk
post
Restart a VM
get
SSH keys attached to a VM + the org's keys
post
Attach an org SSH key to a VM
delete
Detach an org SSH key from a VM
post
Stop a VM
get
Get a VM's embedded Telegram link
post
Terminate a VM
post
Set a VM's endpoint visibility
Webhooks
7
get
List an org's webhooks (no secrets)
post
Create a webhook (returns the signing secret once)
delete
Delete a webhook
patch
Update a webhook (name/url/events)
get
Recent delivery attempts for a webhook
post
Regenerate a webhook's signing secret (returned once)
post
Enable/disable a webhook
Internal
Liveness probe (no auth)
get
/health
Response
Service is up
Health
required
service
string
required
status
string
required