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

GPU utilization, memory, power and temperature time series for a pod

Host-side NVIDIA telemetry for a pod's GPUs, sampled on the node that runs it and returned as one continuous time grid. Every series and every GPU in a response shares that grid: the value at index i of any values array was measured at start plus i times stepSeconds, and a null means the node reported no sample at that point. The window ends now and covers only the periods this pod actually held the GPUs it is reported against, so a card that ran another customer's pod earlier never contributes a sample here. A GPU attached to a VM is passed through to the guest, so the host cannot read it. That case answers 200 with an accelerator status of unavailable and an empty gpus list rather than an error, and so do a pod that has not started yet, a pod that was not running in the selected range, and a metrics store that cannot be reached: the accelerator object is the answer, and the client renders its detail sentence. A host that stopped reporting while the pod is still running answers degraded with the history up to the last sample still attached. This operation is exposed as an agent tool by default, in the same class as a pod's burn rate: "how busy were my GPUs" is a read-only question about a resource the caller already owns.

Command line

The orl CLI wraps this endpoint:

orl vms metrics get <id>
GET
/v1/vms/{id}/metrics
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Query Parameters

range?string

Length of the window ending now. A longer range is returned at a coarser step, so the number of points stays bounded.

Default"1h"

Value in

  • "1h"
  • "6h"
  • "24h"
  • "7d"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/vms/string/metrics"
{  "vmId": "4f6b9a1e-9f1c-4c58-a6a3-1f2f0f6f7a10",  "range": "1h",  "start": "2026-07-18T09:12:00Z",  "end": "2026-07-18T09:15:00Z",  "stepSeconds": 60,  "pointCount": 4,  "accelerator": {    "class": "accelerator",    "status": "available",    "source": "nvidia-smi"  },  "gpus": [    {      "bdf": "0000:04:00.0",      "busySeconds": 169.2,      "series": [        {          "key": "utilization_ratio",          "unit": "ratio",          "values": [            0.97,            0.94,            null,            0.91          ]        },        {          "key": "memory_used_bytes",          "unit": "bytes",          "values": [            42949672960,            43486543872,            null,            43486543872          ]        }      ]    }  ]}