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

List an org's pods (cursor-paginated)

Returns the live compute-fabric pods of the org the API key resolves to as a cursor-paginated page of VmSummary items; terminated pods are left out. A pod is a managed_by=fabric Vm row (capabilityTier=pod), so each item is a VmSummary and paging mirrors listOrgVms.

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 pods list
GET
/v1/pods

Authorization

apiKey
headerAuthorizationBearer <token>

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

Query Parameters

limit?integer
cursor?string

Response Body

Page of pods

application/json
  1. response
items*array<>
nextCursor?string
Example Request
curl -X GET 'https://api.openrelay.inc/v1/pods'
Example Response
{  "items": [    {      "id": "string",      "organizationId": "string",      "name": "string",      "status": "string",      "statusReason": "string",      "gpuModelId": "string",      "gpuCount": 0,      "endpointUrl": "string",      "volumeGb": 0,      "public": true,      "createdAt": "string",      "provisioningStage": "string",      "resourceSize": "string",      "tier": "string",      "diskSizeGb": 0,      "gpuModelName": "string",      "gpuManufacturer": "string",      "pricePerHourCents": 0,      "serviceType": "string",      "managedBy": "string",      "capabilityTier": "string",      "computeClass": "string",      "imageUrl": "string"    }  ],  "nextCursor": "string"}

Overview

GPU pods: bring-your-own-image containers on whole GPUs, with SSH access and an HTTP endpoint. Create and list pods, and check live capacity and rates.

Create a pod POST

Runs your container image as a pod on gpuCount whole GPUs of one node, with SSH access, at the on-demand rate fixed at creation, and returns it as a VmSummary. Compute-fabric pod (BYO container image + SSH keys): a hardened GPU container on gpuCount whole native-driver GPUs of one node. Admission claims free device-request GPU units (see listPodCapacity for what is claimable), snapshots the on-demand rate immutably onto the pod, and drives the guest workflow. A valid request the fleet has no room for right now answers 503 with a capacity code; a GPU count no node could ever hold for the org answers 400 GPU_COUNT_NOT_ALLOCATABLE; and an org without the pod tier answers 409 FEATURE_DISABLED.