Hexel StudioDocs

API referenceConsole

Create agent

POST/registry/v1/agents

Register a new agent in the catalog

Body parameters

Agent details

authoroptional string

capabilitiesoptional array of string

descriptionoptional string

endpointoptional string

imagestring

image_pull_secretoptional ImagePullSecret

3 properties of ImagePullSecret

passwordoptional string

registryoptional string

usernameoptional string

manifestoptional AgentManifest

10 properties of AgentManifest

authenticationoptional object

capabilitiesoptional object

descriptionoptional string

input_schemaoptional object

nameoptional string

output_schemaoptional object

runtimeoptional object

skillsoptional array of ManifestSkill

3 properties of ManifestSkill

idoptional string

inputModesoptional array of string

outputModesoptional array of string

urloptional string

versionoptional string

metadataoptional map[string]

namestring

org_idstring

versionoptional string

Returns

201CreatedAgentResponse

agentoptional Agent

18 properties of Agent

allowed_org_idsoptional array of string

authoroptional string

capabilitiesoptional array of string

created_atoptional string

descriptionoptional string

endpointoptional string

idoptional string

imageoptional string

image_pull_secretoptional ImagePullSecret

3 properties of ImagePullSecret

passwordoptional string

registryoptional string

usernameoptional string

manifestoptional AgentManifest

10 properties of AgentManifest

authenticationoptional object

capabilitiesoptional object

descriptionoptional string

input_schemaoptional object

nameoptional string

output_schemaoptional object

runtimeoptional object

skillsoptional array of ManifestSkill

3 properties of ManifestSkill

idoptional string

inputModesoptional array of string

outputModesoptional array of string

urloptional string

versionoptional string

metadataoptional map[string]

nameoptional string

org_idoptional string

public_keyoptional string

stateoptional string

registered, deploying, running, active, idle, sleeping, stopped, failed

updated_atoptional string

versionoptional string

visibilityoptional string

private, public

Errors

400Bad Request
409Conflict

POST Request

curl --request POST \
  --url 'https://compute.hexelstudio.com/registry/v1/agents' \
  --header 'Content-Type: application/json' \
  --data '{
  "author": "string",
  "capabilities": [
    "string"
  ],
  "description": "string",
  "endpoint": "string",
  "image": "string",
  "image_pull_secret": {
    "password": "string",
    "registry": "string",
    "username": "string"
  },
  "manifest": {
    "authentication": {},
    "capabilities": {},
    "description": "string",
    "input_schema": {},
    "name": "string",
    "output_schema": {},
    "runtime": {},
    "skills": [
      {
        "id": "string",
        "inputModes": [
          "string"
        ],
        "outputModes": [
          "string"
        ]
      }
    ],
    "url": "string",
    "version": "string"
  },
  "metadata": {
    "key": "string"
  },
  "name": "string",
  "org_id": "string",
  "version": "string"
}'

const res = await fetch("https://compute.hexelstudio.com/registry/v1/agents", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "author": "string",
    "capabilities": [
      "string"
    ],
    "description": "string",
    "endpoint": "string",
    "image": "string",
    "image_pull_secret": {
      "password": "string",
      "registry": "string",
      "username": "string"
    },
    "manifest": {
      "authentication": {},
      "capabilities": {},
      "description": "string",
      "input_schema": {},
      "name": "string",
      "output_schema": {},
      "runtime": {},
      "skills": [
        {
          "id": "string",
          "inputModes": [
            "string"
          ],
          "outputModes": [
            "string"
          ]
        }
      ],
      "url": "string",
      "version": "string"
    },
    "metadata": {
      "key": "string"
    },
    "name": "string",
    "org_id": "string",
    "version": "string"
  }),
})
const data = await res.json()

import os
import requests

res = requests.post(
    "https://compute.hexelstudio.com/registry/v1/agents",
    json={
        "author": "string",
        "capabilities": [
            "string",
        ],
        "description": "string",
        "endpoint": "string",
        "image": "string",
        "image_pull_secret": {
            "password": "string",
            "registry": "string",
            "username": "string",
        },
        "manifest": {
            "authentication": {},
            "capabilities": {},
            "description": "string",
            "input_schema": {},
            "name": "string",
            "output_schema": {},
            "runtime": {},
            "skills": [
                {
                    "id": "string",
                    "inputModes": [
                        "string",
                    ],
                    "outputModes": [
                        "string",
                    ],
                },
            ],
            "url": "string",
            "version": "string",
        },
        "metadata": {
            "key": "string",
        },
        "name": "string",
        "org_id": "string",
        "version": "string",
    },
)
data = res.json()

Response

{
  "agent": {
    "allowed_org_ids": [
      "string"
    ],
    "author": "string",
    "capabilities": [
      "string"
    ],
    "created_at": "2026-01-01T00:00:00Z",
    "description": "string",
    "endpoint": "string",
    "id": "string",
    "image": "string",
    "image_pull_secret": {
      "password": "string",
      "registry": "string",
      "username": "string"
    },
    "manifest": {
      "authentication": {},
      "capabilities": {},
      "description": "string",
      "input_schema": {},
      "name": "string",
      "output_schema": {},
      "runtime": {},
      "skills": [
        {
          "id": "string",
          "inputModes": [
            "string"
          ],
          "outputModes": [
            "string"
          ]
        }
      ],
      "url": "string",
      "version": "string"
    },
    "metadata": {
      "key": "string"
    },
    "name": "string",
    "org_id": "string",
    "public_key": "string",
    "state": "string",
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string",
    "visibility": "string"
  }
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}