Hexel StudioDocs

API referenceConsole

List VM usage records

GET/compute/v1/usage

Returns VM usage records for the caller's org, optionally filtered by date range and tier

Query parameters

fromoptional string

Start date (YYYY-MM-DD), default 30 days ago

tooptional string

End date (YYYY-MM-DD), default today

tieroptional string

Filter by tier

limitoptional integer

Max records (default 100)

offsetoptional integer

Offset for pagination

Headers

Authorizationstring

Bearer <token>. STS access token. Obtain via POST https://sts.hexelstudio.com/token with X-API-Key header.

X-Workspace-Idstring

Workspace ID

X-Environment-Idstring

Environment ID

Returns

200OKarray of UsageRecord

duration_secondsoptional integer

ended_atoptional string

reasonoptional string

started_atoptional string

tieroptional string

vm_idoptional string

Errors

500Internal Server Error

GET Request

curl --request GET \
  --url 'https://compute.hexelstudio.com/compute/v1/usage' \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'X-Workspace-Id: X_WORKSPACE_ID' \
  --header 'X-Environment-Id: X_ENVIRONMENT_ID'

const res = await fetch("https://compute.hexelstudio.com/compute/v1/usage", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
  },
})
const data = await res.json()

import os
import requests

res = requests.get(
    "https://compute.hexelstudio.com/compute/v1/usage",
    headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"},
)
data = res.json()

Response

[
  {
    "duration_seconds": 0,
    "ended_at": "2026-01-01T00:00:00Z",
    "reason": "string",
    "started_at": "2026-01-01T00:00:00Z",
    "tier": "string",
    "vm_id": "string"
  }
]

{
  "code": 0,
  "error_code": "string",
  "message": "string"
}