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

Get a VM with its GPU/node/template info and price

GET
/v1/vms/{id}/detail

Authorization

apiKey
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/vms/string/detail"
{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "status": "string",
  "statusReason": "string",
  "provisioningStage": "string",
  "gpuModelId": "string",
  "gpuCount": 0,
  "resourceSize": "string",
  "tier": "string",
  "diskSizeGb": 0,
  "diskUsedBytes": 0,
  "diskTotalBytes": 0,
  "imageUrl": "string",
  "containerPort": 0,
  "endpointUrl": "string",
  "public": true,
  "healthy": true,
  "nodeId": "string",
  "internalIp": "string",
  "sshPort": 0,
  "rdpPort": 0,
  "rdpPassword": "string",
  "persistentDiskPath": "string",
  "startedAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "osType": "string",
  "pricePerHourCents": 0,
  "sshHost": "string",
  "sshHandle": "string",
  "sshUser": "string",
  "sshCommand": "string",
  "sshReady": true,
  "serviceType": "string",
  "gpuInfo": {
    "name": "string",
    "vramGb": 0,
    "pricePerHourCents": 0
  },
  "nodeInfo": {
    "hostname": "string",
    "location": "string"
  },
  "templateInfo": {
    "name": "string",
    "osType": "string",
    "osVersion": "string"
  }
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl vms detail get <id>

Get a VM by id GET

Previous Page

Live burn rate, session cost so far, and org runway for a VM GET

Every VM bills at one bundled hourly rate (per-GPU catalog price times GPU count for GPU VMs, a flat size rate for CPU VMs); disk is included, never billed separately. The rate is locked when the usage session opens, so this endpoint reads it from the open usage record when one exists (rateSource=locked) and only falls back to the current catalog when nothing is accruing (rateSource=catalog).