Hexel StudioDocs

API referenceConsole

Get usage summary for current billing period

GET/compute/v1/usage/summary

Returns aggregated VM-seconds consumed by tier for the current calendar month

Headers

Authorizationstring

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

Returns

200OKUsageSummary

by_tieroptional map[integer]

period_endoptional string

period_startoptional string

total_secondsoptional integer

vm_countoptional integer

Errors

500Internal Server Error

GET Request

curl --request GET \
  --url 'https://compute.hexelstudio.com/compute/v1/usage/summary' \
  --header "Authorization: Bearer $ACCESS_TOKEN"

const res = await fetch("https://compute.hexelstudio.com/compute/v1/usage/summary", {
  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/summary",
    headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"},
)
data = res.json()

Response

{
  "by_tier": {
    "key": 0
  },
  "period_end": "string",
  "period_start": "string",
  "total_seconds": 0,
  "vm_count": 0
}

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