Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferenceComputeCatalog

GPU availability by model

Live availability per GPU model for VMs: total and free GPUs and the largest single allocation placeable right now, served from a short-lived cache. Capacity held exclusively for another organization is left out. Free GPUs released from another organization's reservation to the spot market are counted in spotFreeGpus, not freeGpus.

Required permission

Requires the compute.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl catalog gpu-availability get
GET
/v1/gpu-availability

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Response Body

Availability by gpu model

application/json
  1. response
[index: integer]?

Per-model GPU availability for VMs ("vm", vfio-group passthrough). Pod capacity is answered by GET /v1/pods/capacity.

Example Request
curl -X GET 'https://api.openrelay.inc/v1/gpu-availability'
Example Response
[  {    "gpuModelId": "rtx-4090",    "vm": {      "totalGpus": 12,      "freeGpus": 5,      "maxPlaceableGpus": 4    }  }]