Hexel StudioDocs

API referenceConsole

Deploy an agent from the registry

POST/compute/v1/agents/{agent_id}/deploy

Creates a new deployment from a registered agent. Returns a deployment_id to use for all subsequent operations.

Path parameters

Registry Agent ID

Headers

Authorizationstring

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

Body parameters

Deploy options

A JSON object.

Returns

200OKAgent

config_hashoptional string

created_atoptional string

endpointoptional string

endpoint_nameoptional string

idoptional string

imageoptional string

manifestoptional map[any]

metadataoptional map[string]

nameoptional string

registry_idoptional string

skillsoptional array of string

stateoptional string

tieroptional string

tokenoptional string

updated_atoptional string

POST Request

curl --request POST \
  --url 'https://compute.hexelstudio.com/compute/v1/agents/{agent_id}/deploy' \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{}'

const res = await fetch("https://compute.hexelstudio.com/compute/v1/agents/{agent_id}/deploy", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
})
const data = await res.json()

import os
import requests

res = requests.post(
    "https://compute.hexelstudio.com/compute/v1/agents/{agent_id}/deploy",
    headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"},
    json={},
)
data = res.json()

Response

{
  "config_hash": "string",
  "created_at": "2026-01-01T00:00:00Z",
  "endpoint": "string",
  "endpoint_name": "string",
  "id": "string",
  "image": "string",
  "manifest": {
    "key": "string"
  },
  "metadata": {
    "key": "string"
  },
  "name": "string",
  "registry_id": "string",
  "skills": [
    "string"
  ],
  "state": "string",
  "tier": "string",
  "token": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}