Allocate a new Agent VM

POST/compute/v1/vms/allocate

Allocates a VM from the pool or creates a new one for the requesting org

Headers

Authorizationstring

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

Body parameters

Allocation parameters

envoptional map[string]

metadataoptional map[string]

org_idoptional string

secure_runtimeoptional string

skillsoptional array of string

tierstring

ttl_secondsoptional integer

Returns

201CreatedAllocateResponse

endpointoptional string

expires_atoptional string

skills_loadedoptional array of string

stateoptional string

tieroptional string

tokenoptional string

vm_idoptional string

ws_urloptional string

Errors

400Bad Request
503No VMs available, retry shortly

curl --request POST \ --url 'https://compute.hexelstudio.com/compute/v1/vms/allocate' \ --header "Authorization: Bearer $ACCESS_TOKEN" \ --header 'Content-Type: application/json' \ --data '{ "env": { "key": "string" }, "metadata": { "key": "string" }, "org_id": "string", "secure_runtime": "string", "skills": [ "string" ], "tier": "string", "ttl_seconds": 0 }'

const res = await fetch("https://compute.hexelstudio.com/compute/v1/vms/allocate", { method: "POST", headers: { Authorization: `Bearer ${process.env.ACCESS_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({ "env": { "key": "string" }, "metadata": { "key": "string" }, "org_id": "string", "secure_runtime": "string", "skills": [ "string" ], "tier": "string", "ttl_seconds": 0 }), }) const data = await res.json()

import os import requests res = requests.post( "https://compute.hexelstudio.com/compute/v1/vms/allocate", headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"}, json={ "env": { "key": "string", }, "metadata": { "key": "string", }, "org_id": "string", "secure_runtime": "string", "skills": [ "string", ], "tier": "string", "ttl_seconds": 0, }, ) data = res.json()

{ "endpoint": "string", "expires_at": "2026-01-01T00:00:00Z", "skills_loaded": [ "string" ], "state": "string", "tier": "string", "token": "string", "vm_id": "string", "ws_url": "string" }