Skip to content
Hayonix

API reference · Pods

Hardware for pods: per SKU, its prices and what can be launched now in each region

GET/v1/pods/hardware
API keyworkload:readProject
TypeScript
client.pods.listHardware()
Python
client.pods.list_hardware()
CLI
hayonix pods hardware

Every active SKU with its hourly prices and, per region, how many units an on-demand or interruptible pod could get right now. The counts are a snapshot; nothing is held for you.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the workload:read permission (a key's scope, or a role that includes it).

Examples

The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.

curl -sS "$API_BASE_URL/pods/hardware" \
  -H "Authorization: Bearer $API_KEY"

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Query parameters

  • regionstring

    Only this region (default: every active region)

    up to 64 characters

Response

200 JSON — Every active SKU

  • The items

    Show 11 fields of data
    • objectstringrequired

      Always `hardware`: the type of this object

      One ofhardware

    • skustringrequired

      Hardware type code

    • kindstringrequired

      `gpu`: priced per GPU. `cpu`: a CPU-only pod size.

      One ofgpucpu

    • display_namestringrequired

      Name to show people

    • gpu_modelstring | nullrequired

      GPU model; null for CPU SKUs

    • gpu_memory_gbinteger | nullrequired

      Memory per GPU in GB; null for CPU SKUs

    • vcpus_per_unitintegerrequired

      Per GPU for GPU SKUs; per pod for CPU SKUs

    • memory_gb_per_unitintegerrequired

      Memory in GB: per GPU for GPU SKUs; per pod for CPU SKUs

    • interruptible_offeredbooleanrequired

      Sold as interruptible capacity (it has an interruptible price)

    • pricesobjectrequired

      Hourly prices; null when the SKU has no price of that class

      Show 2 fields of prices
      • on_demand_per_hourstring | nullrequired

        Per GPU (GPU SKUs) or per pod (CPU SKUs)

        pattern ^-?[0-9]+$

      • interruptible_per_hourstring | nullrequired

        Integer nano-USD as a decimal string

        pattern ^-?[0-9]+$

    • availabilityarray of objectrequired

      Per active region: what can be launched now (a snapshot, nothing is held)

      Show 6 fields of availability
      • regionstringrequired

        Region code

      • on_demand_max_countintegerrequired

        Largest gpu_count (CPU: 1) an on-demand pod gets now, counting interruptible capacity it would reclaim

      • interruptible_max_countintegerrequired

        Largest gpu_count (CPU: 1) an interruptible pod gets now, from unused capacity only; 0 when not sold as interruptible

      • freeintegerrequired

        GPUs (CPU SKUs: pods of this size) that fit in unused capacity now, summed over the region’s hosts

      • reclaimable_from_interruptibleintegerrequired

        More units on-demand pods could get now by preempting interruptible pods

      • simulatedbooleanrequired

        Capacity on development hosts with simulated GPUs

  • next_cursorany JSON | nullrequired

    Always null: the list is complete

Example response
Example response
{
  "data": [
    {
      "object": "hardware",
      "sku": "string",
      "kind": "gpu",
      "display_name": "string",
      "gpu_model": "string",
      "gpu_memory_gb": 1,
      "vcpus_per_unit": 1,
      "memory_gb_per_unit": 1,
      "interruptible_offered": true,
      "prices": {
        "on_demand_per_hour": "1500000000",
        "interruptible_per_hour": "1500000000"
      },
      "availability": [
        {
          "region": "string",
          "on_demand_max_count": 1,
          "interruptible_max_count": 1,
          "free": 1,
          "reclaimable_from_interruptible": 1,
          "simulated": true
        }
      ]
    }
  ],
  "next_cursor": {}
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.