Record a run step

POST/api/agent/runs/{id}/events

Authorization

AuthorizationBearer token (ba_run_...) · headerrequired

Per-run token returned by start, valid for 6 hours and bound to one run.

AuthorizationBearer token (ba_sk_...) · headerrequired

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

Path parameters

idstringrequired

Run id

Request body

requiredapplication/json

executor_idstring

step_idstringrequired

statusstringrequired

Allowed:startedcompletedfailedinfo

messagestring

metadataobject

Responses

200

eventobject

401

Missing, invalid, expired, or revoked API key

errorstringrequired

codestring

409

RUN_NOT_ACTIVE

errorstringrequired

codestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

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

Parameters

idpath*Run id

Bodyapplication/json

Request body

Request

curl -X POST "https://www.brainyshorts.com/api/agent/runs/string/events" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "executor_id": "string",
  "step_id": "string",
  "status": "started",
  "message": "string",
  "metadata": {}
}'

const response = await fetch("https://www.brainyshorts.com/api/agent/runs/string/events", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"executor_id\": \"string\",\n  \"step_id\": \"string\",\n  \"status\": \"started\",\n  \"message\": \"string\",\n  \"metadata\": {}\n}"
});

import requests

response = requests.post(
    "https://www.brainyshorts.com/api/agent/runs/string/events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"executor_id\": \"string\",\n  \"step_id\": \"string\",\n  \"status\": \"started\",\n  \"message\": \"string\",\n  \"metadata\": {}\n}",
)

Response

{
  "event": {}
}

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

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