Register or update an executor

An executor is the machine and agent that runs local automations. Pass executor_id to update an existing one.

POST/api/agent/executors

Authorization

AuthorizationBearer token (ba_sk_...) · headerrequired

API key from /dashboard/api-keys. Keys expire after 365 days.

Request body

requiredapplication/json

executor_idstring

namestringrequired

max length 100

agent_typestringrequired

max length 50

device_labelstring

capabilitiesobject

Responses

200

executorobject

401

Missing, invalid, expired, or revoked API key

errorstringrequired

codestring

404

EXECUTOR_NOT_FOUND

errorstringrequired

codestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (ba_sk_...)Remember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST "https://www.brainyshorts.com/api/agent/executors" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "executor_id": "string",
  "name": "string",
  "agent_type": "codex",
  "device_label": "string",
  "capabilities": {}
}'

const response = await fetch("https://www.brainyshorts.com/api/agent/executors", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"executor_id\": \"string\",\n  \"name\": \"string\",\n  \"agent_type\": \"codex\",\n  \"device_label\": \"string\",\n  \"capabilities\": {}\n}"
});

import requests

response = requests.post(
    "https://www.brainyshorts.com/api/agent/executors",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"executor_id\": \"string\",\n  \"name\": \"string\",\n  \"agent_type\": \"codex\",\n  \"device_label\": \"string\",\n  \"capabilities\": {}\n}",
)

Response

{
  "executor": {}
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}