Skip to main content
POST
/
instances
Create a GPU instance
curl --request POST \
  --url https://runcrate.ai/api/v1/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "gpu_type": "<string>",
  "instance_type_id": "<string>",
  "region": "<string>",
  "gpu_count": 2,
  "cpu_cores": 2,
  "memory": 2,
  "storage": 2,
  "template": "<string>",
  "ssh_key_id": "<string>",
  "env_vars": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "startup_commands": [
    "<string>"
  ],
  "storage_id": "<string>",
  "launch_script": "<string>",
  "launch_script_base64": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "gpu_type": "<string>",
    "gpu_count": 123,
    "cpu_cores": 123,
    "memory": 123,
    "storage": 123,
    "region": "<string>",
    "ip": "<string>",
    "os_image": "<string>",
    "cost_per_hour": 123,
    "deployed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://runcrate.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a Runcrate API key with the rc_live_* prefix as the bearer token. Create one at https://www.runcrate.ai/dashboard/api-keys.

Body

application/json

Provide either gpu_type (auto-deploy to cheapest available config) or instance_type_id (specific config from /instances/types).

​
name
string
required

Human-readable instance name.

​
gpu_type
string

GPU model id (e.g. h100-sxm). Required if instance_type_id is not provided.

​
instance_type_id
string

Exact instance-type id from GET /instances/types. Required if gpu_type is not provided.

​
region
string

Region preference. Defaults to auto.

​
gpu_count
integer
Required range: x >= 1
​
cpu_cores
integer
Required range: x >= 1
​
memory
integer

GB

Required range: x >= 1
​
storage
integer

GB ephemeral storage

Required range: x >= 1
​
template
string

Template id to boot from.

​
ssh_key_id
string

ID of an SSH key to inject (create one via POST /ssh-keys).

​
env_vars
object[]

Environment variables to inject. Each item must be { "key": "NAME", "value": "..." }.

​
startup_commands
string[]
​
storage_id
string

Persistent volume to attach at boot. Mounts at /workspace.

​
launch_script
string

Raw shell script to run on boot.

​
launch_script_base64
string

Base64-encoded launch script (alternative to launch_script).

Response

Instance created. Status will be starting or deploying until ready.

​
data
object
required