Skip to content
Hayonix

API reference · Schema

CreatePodRequest

  • namestringrequired

    Its name

    1–100 characters

  • hostnamestring

    Name in the project’s private network (default: from the name)

    pattern ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

  • template_idstring

    ID of the template

    ID with prefix tpl_

  • imagestring

    Image reference; defaults to the template’s

    1–512 characters

  • hardwarePodHardwarerequired
    Show 2 fields of hardware
    • skustringrequired

      Hardware type code

      1–64 characters

    • gpu_countinteger

      Number of GPUs

      0–8 · default 0

  • regionstringrequired

    Region code

    1–64 characters

  • pricing_classstring

    `interruptible` costs less and may be stopped (preempted) when on-demand work needs the capacity; it then waits in the queue to run again. On-demand pods are never preempted.

    One ofon_demandinterruptible

  • container_disk_gbinteger

    Writable container disk; reset whenever the container is recreated (stop, reconfigure). Default 20.

    5–500

  • Network volumes to mount. A pod that mounts a volume runs on the host the volume is pinned to.

    up to 4 items

    Show 3 fields of network_volumes
    • volume_idstringrequired

      ID of the volume

      ID with prefix vol_

    • mount_pathstringrequired

      Absolute path the volume is mounted at inside the container

      2–256 characters

    • read_onlyboolean

      Mount the volume read-only in this pod

      default false

  • Container ports to expose; each public HTTP port gets its own HTTPS URL

    up to 16 items

    Show 4 fields of ports
    • portintegerrequired

      Port number the container listens on

      1–65535

    • protocolstring

      `http`: served at the port’s HTTPS URL (WebSocket included). `tcp`: raw TCP, reachable through SSH port forwarding.

      One ofhttptcp

      default "http"

    • visibilitystring

      `public`: anyone with the URL. `private`: no URL; SSH port forwarding and the project network only.

      One ofpublicprivate

      default "public"

    • namestring

      Its name

      pattern ^[a-z][a-z0-9-]{0,30}$

  • envarray of object

    Plain environment variables. Names starting with POD_, NVIDIA_ or LD_ are reserved.

    up to 128 items

    Show 2 fields of env
    • namestringrequired

      Its name

      pattern ^[A-Za-z_][A-Za-z0-9_]{0,127}$

    • valuestringrequired

      Value of the variable (up to 32,768 characters)

      up to 32768 characters

  • secret_envarray of object

    Environment variables whose values come from project secrets, read when the container is created.

    up to 128 items

    Show 2 fields of secret_env
    • namestringrequired

      Its name

      pattern ^[A-Za-z_][A-Za-z0-9_]{0,127}$

    • secret_idstringrequired

      ID of the secret

      ID with prefix sec_

  • commandarray of string

    Replaces the image’s entrypoint when non-empty

    up to 64 items

  • argsarray of string

    Replaces the image’s default arguments when non-empty

    up to 256 items

  • registry_credential_idstring | null

    ID of the registry credential

    ID with prefix rcr_

  • sshboolean

    Allow SSH (and SFTP, port forwarding) with the project’s SSH keys

  • Models from the model hub, cached on the host and mounted read-only at /model-cache/models--<owner>--<name> (HF_HUB_CACHE points there unless env sets it). Changing them recreates the container.

    up to 8 items

    Show 1 field of models
    • reference_idstringrequired

      A model reference of this project (POST /v1/model-references)

      ID with prefix mrf_

  • volumeNewPodVolume | ExistingPodVolume | any JSON | null

    The pod’s own persistent volume (default: the template’s; null for none). It survives stops and reconfiguration and is deleted on terminate unless kept.

Example
{
  "name": "notebook",
  "image": "quay.io/jupyter/base-notebook:2026-11-10",
  "hardware": {
    "sku": "cpu-2c-4gb",
    "gpu_count": 0
  },
  "region": "dev-local-1",
  "volume": {
    "size_gb": 10,
    "mount_path": "/home/jovyan/work"
  },
  "ports": [
    {
      "port": 8888,
      "protocol": "http",
      "visibility": "public"
    }
  ]
}

Used by