Skip to content

API

Suggest Edits
Base URLhttp://localhost:3737 OpenAPI JSON OpenAPI 3.1.0
56 endpoints

GET/api/activity

List activity feed events

Returns unified activity data from audit events and task logs.

Operationcore.get.api-activity
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/activity'

POST/api/activity/emit

Emit activity event

Operationcore.post.api-activity-emit
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "agent": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "ts": {
      "type": "string"
    }
  },
  "required": [
    "agent",
    "message",
    "ts"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/activity/emit' \
-H 'Content-Type: application/json' \
--data '{"agent":"value","message":"value","ts":"value"}'

GET/api/agent-packages

List agent packages

Operationcore.get.api-agent-packages
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/agent-packages'

DELETE/api/agent-packages/:agentId

Remove agent package

Operationcore.delete.api-agent-packages-agent-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes
{
  "type": "object",
  "properties": {
    "keepBlocks": {
      "type": "boolean"
    },
    "deleteAgent": {
      "type": "boolean"
    },
    "force": {
      "type": "boolean"
    }
  },
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/agent-packages/<agentId>' \
-H 'Content-Type: application/json' \
--data '{"keepBlocks":true,"deleteAgent":true,"force":true}'

GET/api/agent-packages/:agentId/lessons

List agent package lessons

Operationcore.get.api-agent-packages-agent-id-lessons
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/agent-packages/<agentId>/lessons'

POST/api/agent-packages/:agentId/lessons/:lessonId

Toggle agent package lessons

Operationcore.post.api-agent-packages-agent-id-lessons-lesson-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes
lessonIdpathyes
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/agent-packages/<agentId>/lessons/<lessonId>' \
-H 'Content-Type: application/json' \
--data '{"enabled":true}'

POST/api/agent-packages/:agentId/update

Update agent package

Operationcore.post.api-agent-packages-agent-id-update
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes
{
  "type": "object",
  "properties": {
    "refreshTemplate": {
      "type": "boolean"
    }
  },
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/agent-packages/<agentId>/update' \
-H 'Content-Type: application/json' \
--data '{"refreshTemplate":true}'

POST/api/agent-packages/install

Install agent package

Operationcore.post.api-agent-packages-install
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "source": {
      "type": "string"
    },
    "adopt": {
      "type": "boolean"
    },
    "installAs": {
      "type": "string"
    }
  },
  "required": [
    "source"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/agent-packages/install' \
-H 'Content-Type: application/json' \
--data '{"source":"value","adopt":true,"installAs":"value"}'

GET/api/agents

List agents

Lists all agents with status and active tasks.

Operationcore.get.api-agents
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/agents'

GET/api/agents/:id

Get agent status

Operationcore.get.api-agents-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
idpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/agents/<id>'

POST/api/agents/:id/message

Send message to agent

Operationcore.post.api-agents-id-message
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
idpathyes
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "required": [
    "message"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/agents/<id>/message' \
-H 'Content-Type: application/json' \
--data '{"message":"value"}'

GET/api/agents/:id/status

Get detailed agent status

Operationcore.get.api-agents-id-status
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
idpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/agents/<id>/status'

GET/api/agents/:id/tasks

Get agent tasks

Operationcore.get.api-agents-id-tasks
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
idpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/agents/<id>/tasks'

GET/api/agents/avatar

Get agent avatar

Serves an agent avatar image.

Operationcore.get.api-agents-avatar
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
idqueryyes

No request body.

{
  "type": "string",
  "format": "binary"
}
Terminal window
curl -sS \
'http://localhost:3737/api/agents/avatar?id=<id>'

GET/api/agents/health

List agent health status

Returns enriched heartbeat and staleness data for agents.

Operationcore.get.api-agents-health
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/agents/health'

POST/api/agents/restart

Restart an agent

Operationcore.post.api-agents-restart
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "agentId": {
      "type": "string"
    }
  },
  "required": [
    "agentId"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/agents/restart' \
-H 'Content-Type: application/json' \
--data '{"agentId":"value"}'

GET/api/agents/settings

Get agent settings

Returns host display and behavior settings for agents.

Operationcore.get.api-agents-settings
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/agents/settings'

PUT/api/agents/settings

Update agent settings

Updates host display and behavior settings for agents.

Operationcore.put.api-agents-settings
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/agents/settings' \
-H 'Content-Type: application/json' \
--data '{}'

POST/api/agents/start

Start an agent

Operationcore.post.api-agents-start
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "agentId": {
      "type": "string"
    }
  },
  "required": [
    "agentId"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/agents/start' \
-H 'Content-Type: application/json' \
--data '{"agentId":"value"}'

POST/api/agents/stop

Stop an agent

Operationcore.post.api-agents-stop
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "agentId": {
      "type": "string"
    }
  },
  "required": [
    "agentId"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/agents/stop' \
-H 'Content-Type: application/json' \
--data '{"agentId":"value"}'

GET/api/assets/:path

Serve asset file

Operationcore.get.api-assets-path
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
pathpathyes

No request body.

{
  "type": "string",
  "format": "binary"
}
Terminal window
curl -sS \
'http://localhost:3737/api/assets/<path>'

GET/api/curated

List curated installable packages

Operationcore.get.api-curated
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/curated'

GET/api/dev/events

Dev SSE event stream

Development-only browser reload and notification event stream.

Operationcore.get.api-dev-events
Stabilitystable
Visibilityinternal

No request body.

200 Successful response.

{
  "type": "string",
  "format": "binary"
}
Terminal window
curl -sS \
'http://localhost:3737/api/dev/events'

POST/api/dev/notify

Emit development notification

Development-only watcher bridge for browser rebuild notifications.

Operationcore.post.api-dev-notify
Stabilitystable
Visibilityinternal
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {}
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/dev/notify' \
-H 'Content-Type: application/json' \
--data '{"type":"value","payload":"value"}'

GET/api/dispatch

Get dispatch timer state

Returns interval, last run, next run, and dispatched count.

Operationcore.get.api-dispatch
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/dispatch'

POST/api/dispatch

Trigger dispatch

Triggers an immediate task dispatch cycle.

Operationcore.post.api-dispatch
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/dispatch'

GET/api/docs

Get API documentation

Legacy endpoint — returns route metadata in the {routes} shape for CLI consumers.

Operationcore.get.api-docs
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/docs'

GET/api/events

SSE event stream

Real-time updates for file changes, task events, alerts.

Operationcore.get.api-events
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "string",
  "format": "binary"
}
Terminal window
curl -sS \
'http://localhost:3737/api/events'

POST/api/exec-tools/:toolName

Run an exec tool

Operationcore.post.api-exec-tools-tool-name
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
toolNamepathyes
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/exec-tools/<toolName>' \
-H 'Content-Type: application/json' \
--data '{}'

POST/api/internal/continuation

Trigger continuation check

Operationcore.post.api-internal-continuation
Stabilitystable
Visibilityinternal
{
  "type": "object",
  "properties": {
    "completedTaskId": {
      "type": "string"
    },
    "completedTitle": {
      "type": "string"
    }
  },
  "required": [
    "completedTaskId",
    "completedTitle"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/internal/continuation' \
-H 'Content-Type: application/json' \
--data '{"completedTaskId":"value","completedTitle":"value"}'

POST/api/memory/log

Append memory log entry

Operationcore.post.api-memory-log
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "decision",
        "learned",
        "note"
      ]
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "message"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/memory/log' \
-H 'Content-Type: application/json' \
--data '{"type":"decision","message":"value"}'

GET/api/openapi

Get live OpenAPI document

Returns the OpenAPI 3.1 document built from the runtime route registry.

Operationcore.get.api-openapi
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/openapi'

GET/api/packages

List reusable packages

Operationcore.get.api-packages
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/packages'

DELETE/api/packages/:packageId

Remove reusable package

Operationcore.delete.api-packages-package-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
packageIdpathyes

No request body.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/packages/<packageId>'

POST/api/packages/:packageId/update

Update reusable package

Operationcore.post.api-packages-package-id-update
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
packageIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/packages/<packageId>/update'

POST/api/packages/install

Install reusable package

Operationcore.post.api-packages-install
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "source": {
      "type": "string"
    }
  },
  "required": [
    "source"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/packages/install' \
-H 'Content-Type: application/json' \
--data '{"source":"value"}'

GET/api/paths

Get resolved runtime paths

Returns important local filesystem paths used by the runtime.

Operationcore.get.api-paths
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/paths'

GET/api/plugin-settings/:pluginId

Get plugin settings

Operationcore.get.api-plugin-settings-plugin-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
pluginIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugin-settings/<pluginId>'

PUT/api/plugin-settings/:pluginId

Update plugin settings

Operationcore.put.api-plugin-settings-plugin-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
pluginIdpathyes
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugin-settings/<pluginId>' \
-H 'Content-Type: application/json' \
--data '{}'

GET/api/plugin-settings/schemas

List plugin settings schemas

Operationcore.get.api-plugin-settings-schemas
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugin-settings/schemas'

GET/api/plugins/:pluginId/assets/:path

Serve plugin client asset

Operationcore.get.api-plugins-plugin-id-assets-path
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
pluginIdpathyes
pathpathyes

No request body.

{
  "type": "string",
  "format": "binary"
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/<pluginId>/assets/<path>'

POST/api/plugins/install

Install plugin

Operationcore.post.api-plugins-install
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "source": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "local",
        "github"
      ]
    }
  },
  "required": [
    "source",
    "type"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/install' \
-H 'Content-Type: application/json' \
--data '{"source":"value","type":"local"}'

GET/api/plugins/manifest

Get plugin manifest bundle

Operationcore.get.api-plugins-manifest
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/manifest'

GET/api/plugins/memory/audit

List memory audit entries

Operationcore.get.api-plugins-memory-audit
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/audit'

GET/api/plugins/memory/workspace

Get memory workspace bundle

Operationcore.get.api-plugins-memory-workspace
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdqueryyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/workspace?agentId=<agentId>'

POST/api/plugins/remove

Remove plugin

Operationcore.post.api-plugins-remove
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "pluginId": {
      "type": "string"
    }
  },
  "required": [
    "pluginId"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/remove' \
-H 'Content-Type: application/json' \
--data '{"pluginId":"value"}'

POST/api/plugins/restore

Restore plugin

Operationcore.post.api-plugins-restore
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "pluginId": {
      "type": "string"
    },
    "snapshot": {
      "type": "string"
    },
    "force": {
      "type": "boolean"
    },
    "listOnly": {
      "type": "boolean"
    }
  },
  "required": [
    "pluginId"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/restore' \
-H 'Content-Type: application/json' \
--data '{"pluginId":"value","snapshot":"value","force":true,"listOnly":true}'

POST/api/plugins/upgrade

Upgrade plugin

Operationcore.post.api-plugins-upgrade
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "pluginId": {
      "type": "string"
    }
  },
  "required": [
    "pluginId"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/upgrade' \
-H 'Content-Type: application/json' \
--data '{"pluginId":"value"}'

POST/api/reindex

Trigger reindex

Operationcore.post.api-reindex
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/reindex'

GET/api/settings

Get settings

Returns current Bakin settings.

Operationcore.get.api-settings
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/settings'

POST/api/settings

Update settings

Updates Bakin settings with a partial merge.

Operationcore.post.api-settings
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/settings' \
-H 'Content-Type: application/json' \
--data '{}'

GET/api/state

Get dashboard state snapshot

Operationcore.get.api-state
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/state'

GET/api/version

Get runtime version

Returns the running Bakin version.

Operationcore.get.api-version
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string"
    }
  },
  "required": [
    "version"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/version'
12 endpoints

GET/api/plugins/assets/

List assets

List assets with optional filter parameters.

Operationassets.get.root
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/assets/'

DELETE/api/plugins/assets/

Soft-delete an asset

Operationassets.delete.root
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/plugins/assets/'

PUT/api/plugins/assets/content

Update text content of an editable asset

Operationassets.put.content
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/assets/content' \
-H 'Content-Type: application/json' \
--data '{}'

GET/api/plugins/assets/file

Serve asset file

Streams an asset file by canonical filename for rendering.

Operationassets.get.file
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "string",
  "format": "binary"
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/assets/file'

PATCH/api/plugins/assets/retype

Change asset type classification

Operationassets.patch.retype
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PATCH \
'http://localhost:3737/api/plugins/assets/retype' \
-H 'Content-Type: application/json' \
--data '{}'

GET/api/plugins/assets/search

Search assets

Full-text search across assets indexed content.

Operationassets.get.search
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
qqueryyes
limitqueryno
offsetqueryno
facetsqueryno

No request body.

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {}
    },
    "aggregations": {},
    "meta": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string"
        },
        "total": {
          "type": "number"
        },
        "took_ms": {
          "type": "number"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "query",
        "total",
        "took_ms",
        "source"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "results"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/assets/search?q=<q>&limit=<limit>&offset=<offset>&facets=<facets>'

GET/api/plugins/assets/trash

List trashed assets

Operationassets.get.trash
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/assets/trash'

DELETE/api/plugins/assets/trash

Empty entire trash

Operationassets.delete.trash
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/plugins/assets/trash'

DELETE/api/plugins/assets/trash/:file

Permanently delete a trashed asset

Operationassets.delete.trash-file
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
filepathyes

No request body.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/plugins/assets/trash/<file>'

POST/api/plugins/assets/trash/:file/restore

Restore a trashed asset

Operationassets.post.trash-file-restore
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
filepathyes

No request body.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/assets/trash/<file>/restore'

POST/api/plugins/assets/upload

Upload asset files

Operationassets.post.upload
Stabilitystable
Visibilitypublic
{
  "type": "string",
  "format": "binary"
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/assets/upload' \
-H 'Content-Type: multipart/form-data' \
--data '"value"'
3 endpoints

GET/api/plugins/git/worktrees

List tracked git worktrees

Operationgit.get.worktrees
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
repoPathqueryno
taskIdqueryno
includeReleasedqueryno

No request body.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/git/worktrees?repoPath=<repoPath>&taskId=<taskId>&includeReleased=<includeReleased>'

POST/api/plugins/git/worktrees/prepare

Create or reuse an isolated git worktree for a task

Operationgit.post.worktrees-prepare
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "repoPath": {
      "type": "string",
      "minLength": 1
    },
    "taskId": {
      "type": "string",
      "minLength": 1
    },
    "branch": {
      "type": "string",
      "minLength": 1
    },
    "baseRef": {
      "default": "HEAD",
      "type": "string",
      "minLength": 1
    },
    "purpose": {
      "type": "string",
      "maxLength": 200
    },
    "agent": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "repoPath",
    "taskId",
    "baseRef"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/git/worktrees/prepare' \
-H 'Content-Type: application/json' \
--data '{"repoPath":"value","taskId":"value","branch":"value","baseRef":"value","purpose":"value","agent":"value"}'

POST/api/plugins/git/worktrees/release

Release a tracked git worktree

Operationgit.post.worktrees-release
Stabilitystable
Visibilitypublic
{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "worktreePath": {
          "type": "string",
          "minLength": 1
        },
        "repoPath": {
          "type": "string",
          "minLength": 1
        },
        "taskId": {
          "type": "string",
          "minLength": 1
        },
        "force": {
          "default": false,
          "type": "boolean"
        }
      },
      "required": [
        "force"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "agent": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    }
  ]
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/git/worktrees/release' \
-H 'Content-Type: application/json' \
--data '"value"'
7 endpoints

GET/api/plugins/health/checks

List registered plugin health checks

Returns metadata only; does not execute the checks.

Operationhealth.get.checks
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "pluginId": {
            "type": "string"
          },
          "autoFix": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "name",
          "autoFix"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "checks"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/health/checks'

GET/api/plugins/health/doctor

Run system diagnostics

Returns cached doctor results by default; pass ?fresh=true to force a fresh run.

Operationhealth.get.doctor
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
freshqueryno

No request body.

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": {}
      }
    },
    "summary": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "errors": {
          "type": "number"
        },
        "warnings": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "errors",
        "warnings"
      ],
      "additionalProperties": false
    },
    "cachedAt": {
      "type": "string"
    }
  },
  "required": [
    "results",
    "summary"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/health/doctor?fresh=<fresh>'

GET/api/plugins/health/registry

List registered plugins

Returns the plugin registry snapshot — installed plugin metadata and route counts.

Operationhealth.get.registry
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {
    "plugins": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": {}
      }
    }
  },
  "required": [
    "plugins"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/health/registry'

GET/api/plugins/health/search-status

Search adapter health

Returns search adapter readiness and per-table index stats.

Operationhealth.get.search-status
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "tables": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": {}
      }
    }
  },
  "required": [
    "enabled",
    "tables"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/health/search-status'

GET/api/plugins/health/summary

Aggregated health summary

Snapshot of doctor cache, recent error counts, MCP sessions, and host process metrics.

Operationhealth.get.summary
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {
    "doctor": {
      "anyOf": [
        {},
        {
          "type": "null"
        }
      ]
    },
    "errors1h": {},
    "activeSessions": {
      "type": "array",
      "items": {}
    },
    "upSince": {
      "type": "string"
    },
    "server": {
      "type": "object",
      "properties": {
        "port": {
          "type": "number"
        },
        "pid": {
          "type": "number"
        },
        "nodeVersion": {
          "type": "string"
        },
        "memoryMB": {
          "type": "number"
        },
        "totalMemoryMB": {
          "type": "number"
        }
      },
      "required": [
        "port",
        "pid",
        "nodeVersion",
        "memoryMB",
        "totalMemoryMB"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "doctor",
    "errors1h",
    "activeSessions",
    "upSince",
    "server"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/health/summary'

GET/api/plugins/health/usage

Agent context/token usage

Returns token + context usage per agent from runtime sessions.

Operationhealth.get.usage
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {},
    "additionalProperties": {}
  }
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/health/usage'

GET/api/plugins/health/usage-feed

Unified usage feed

Backs the tabbed usage section on the health page. Filters by kind, time window, and agent.

Operationhealth.get.usage-feed
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
kindqueryno
windowqueryno
agentqueryno

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/health/usage-feed?kind=<kind>&window=<window>&agent=<agent>'
15 endpoints

GET/api/plugins/memory/checkpoints

List compaction checkpoints for an agent (optionally by session)

List compaction checkpoints for an agent (optionally by session)

Operationmemory.get.checkpoints
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/checkpoints'

GET/api/plugins/memory/checkpoints/:agent/:sessionId/:checkpointId

Read one checkpoint by (agent, sessionId, checkpointId)

Read one checkpoint by (agent, sessionId, checkpointId)

Operationmemory.get.checkpoints-agent-session-id-checkpoint-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentpathyes
sessionIdpathyes
checkpointIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/checkpoints/<agent>/<sessionId>/<checkpointId>'

GET/api/plugins/memory/daily-notes

List daily notes for an agent (sorted by date desc)

List daily notes for an agent (sorted by date desc)

Operationmemory.get.daily-notes
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/daily-notes'

GET/api/plugins/memory/daily-notes/:agent/:filename

Read one daily note

Read one daily note

Operationmemory.get.daily-notes-agent-filename
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentpathyes
filenamepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/daily-notes/<agent>/<filename>'

GET/api/plugins/memory/dreams

List dream artifacts for an agent (optional phase/date/artifactType filters)

List dream artifacts for an agent (optional phase/date/artifactType filters)

Operationmemory.get.dreams
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/dreams'

GET/api/plugins/memory/dreams/:agent/:artifactType

Read one dream artifact by (agent, artifactType[, phase, date])

Read one dream artifact by (agent, artifactType[, phase, date])

Operationmemory.get.dreams-agent-artifact-type
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentpathyes
artifactTypepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/dreams/<agent>/<artifactType>'

GET/api/plugins/memory/durable

List canonical durable files

List canonical durable files present for an agent

Operationmemory.get.durable
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "files"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/durable'

GET/api/plugins/memory/durable/:agent/:basename

Read one durable file

Read one canonical durable file for an agent

Operationmemory.get.durable-agent-basename
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentpathyes
basenamepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/durable/<agent>/<basename>'

GET/api/plugins/memory/recent

Recent memory items across tiers, sorted by updated_at desc

Recent memory items across tiers, sorted by updated_at desc

Operationmemory.get.recent
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/recent'

GET/api/plugins/memory/sessions

List sessions for an agent

List sessions for an agent

Operationmemory.get.sessions
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/sessions'

GET/api/plugins/memory/sessions/:agent/:sessionKey

Read one session by key

Read one session by key

Operationmemory.get.sessions-agent-session-key
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentpathyes
sessionKeypathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/sessions/<agent>/<sessionKey>'

GET/api/plugins/memory/sessions/:agent/:sessionKey/turns

List turns belonging to one session (indexed)

List turns belonging to one session (indexed)

Operationmemory.get.sessions-agent-session-key-turns
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentpathyes
sessionKeypathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/sessions/<agent>/<sessionKey>/turns'

GET/api/plugins/memory/status

Indexer health: per-tier row counts + offset snapshot

Indexer health: per-tier row counts + offset snapshot

Operationmemory.get.status
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/status'

GET/api/plugins/memory/turns

List turns by (agent, sessionId)

List turns by (agent, sessionId)

Operationmemory.get.turns
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/memory/turns'
11 endpoints

GET/api/plugins/models/aliases

List model aliases

Operationmodels.get.aliases
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/models/aliases'

POST/api/plugins/models/aliases

Add/delete/prepopulate model aliases

Operationmodels.post.aliases
Stabilitystable
Visibilitypublic
{
  "anyOf": [
    {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "const": "add"
            },
            "name": {
              "type": "string",
              "minLength": 1
            },
            "target": {
              "type": "string",
              "minLength": 1
            }
          },
          "required": [
            "action",
            "name",
            "target"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "const": "delete"
            },
            "name": {
              "type": "string",
              "minLength": 1
            }
          },
          "required": [
            "action",
            "name"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "const": "prepopulate"
            }
          },
          "required": [
            "action"
          ],
          "additionalProperties": false
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "aliases": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "required": [
        "aliases"
      ],
      "additionalProperties": false
    }
  ]
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/models/aliases' \
-H 'Content-Type: application/json' \
--data '"value"'

GET/api/plugins/models/available

List available models

Returns the model catalog from the configured runtime adapter. Cached on disk; the response signals freshness.

Operationmodels.get.available
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/models/available'

GET/api/plugins/models/config

Get model config

Operationmodels.get.config
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/models/config'

POST/api/plugins/models/config

Update agent model config

Operationmodels.post.config
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "agentId": {
      "type": "string",
      "minLength": 1
    },
    "ownModel": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "subagentModel": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "agentId"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/models/config' \
-H 'Content-Type: application/json' \
--data '{"agentId":"value","ownModel":"value","subagentModel":"value"}'

POST/api/plugins/models/defaults

Update default models

Operationmodels.post.defaults
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "defaultModel": {
      "type": "string"
    },
    "defaultSubagentModel": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "fallbackModels": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/models/defaults' \
-H 'Content-Type: application/json' \
--data '{"defaultModel":"value","defaultSubagentModel":"value","fallbackModels":["value"]}'

GET/api/plugins/models/profiles

List task profiles

Operationmodels.get.profiles
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/models/profiles'

PUT/api/plugins/models/profiles

Replace task profiles

Operationmodels.put.profiles
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "profiles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "taskType": {
            "type": "string",
            "minLength": 1
          },
          "recommendedModel": {
            "type": "string",
            "minLength": 1
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "taskType",
          "recommendedModel",
          "notes"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "profiles"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/models/profiles' \
-H 'Content-Type: application/json' \
--data '{"profiles":[{"taskType":"value","recommendedModel":"value","notes":"value"}]}'

POST/api/plugins/models/refresh

Refresh model list (bypass cache)

Forces a fresh fetch from the runtime adapter, bypassing both cache layers. Falls back to last-known-good cache on failure.

Operationmodels.post.refresh
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/models/refresh'

POST/api/plugins/models/runtime/restart

Restart the runtime

Operationmodels.post.runtime-restart
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/models/runtime/restart'

GET/api/plugins/models/runtime/status

Runtime config sync status

Reports whether the runtime config is out of sync with disk and needs a restart.

Operationmodels.get.runtime-status
Stabilitystable
Visibilitypublic

No request body.

200 Successful response.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/models/runtime/status'
13 endpoints

GET/api/plugins/schedule/

List all scheduled jobs

Returns the merged runtime cron + Bakin sidecar view of all jobs.

Operationschedule.get.root
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/schedule/'

POST/api/plugins/schedule/

Create a scheduled job

Operationschedule.post.root
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "schedule": {
      "type": "string",
      "minLength": 1
    },
    "agentId": {
      "type": "string"
    },
    "workflowId": {
      "type": "string"
    },
    "taskPrompt": {
      "type": "string"
    },
    "taskTitle": {
      "type": "string"
    },
    "owner": {
      "type": "string"
    },
    "requireTriage": {
      "type": "boolean"
    },
    "allowOverlap": {
      "type": "boolean"
    },
    "maxFailures": {
      "type": "number"
    },
    "tz": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "schedule"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/schedule/' \
-H 'Content-Type: application/json' \
--data '{"name":"value","schedule":"value","agentId":"value","workflowId":"value","taskPrompt":"value","taskTitle":"value","owner":"value","requireTriage":true,"allowOverlap":true,"maxFailures":1,"tz":"value"}'

GET/api/plugins/schedule/:jobId

Get scheduled job details

Operationschedule.get.job-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
jobIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/schedule/<jobId>'

PUT/api/plugins/schedule/:jobId

Update a scheduled job

Operationschedule.put.job-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
jobIdpathyes
{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/schedule/<jobId>' \
-H 'Content-Type: application/json' \
--data '{"jobId":"value"}'

DELETE/api/plugins/schedule/:jobId

Delete a scheduled job

Operationschedule.delete.job-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
jobIdpathyes
{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/plugins/schedule/<jobId>' \
-H 'Content-Type: application/json' \
--data '{"jobId":"value"}'

POST/api/plugins/schedule/:jobId/adopt

Adopt a runtime cron job into Bakin task scheduling

Operationschedule.post.job-id-adopt
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
jobIdpathyes
{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "schedule": {
      "type": "string"
    },
    "agentId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "workflowId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "taskPrompt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "taskTitle": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "owner": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "requireTriage": {
      "type": "boolean"
    },
    "allowOverlap": {
      "type": "boolean"
    },
    "maxFailures": {
      "type": "number"
    },
    "tz": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/schedule/<jobId>/adopt' \
-H 'Content-Type: application/json' \
--data '{"jobId":"value","name":"value","schedule":"value","agentId":"value","workflowId":"value","taskPrompt":"value","taskTitle":"value","owner":"value","requireTriage":true,"allowOverlap":true,"maxFailures":1,"tz":"value"}'

POST/api/plugins/schedule/:jobId/pause

Pause/resume/skip a scheduled job

Operationschedule.post.job-id-pause
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
jobIdpathyes
{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    },
    "action": {
      "type": "string",
      "enum": [
        "pause",
        "resume",
        "skip"
      ]
    },
    "pauseUntil": {
      "type": "string"
    },
    "skipN": {
      "type": "number"
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/schedule/<jobId>/pause' \
-H 'Content-Type: application/json' \
--data '{"jobId":"value","action":"pause","pauseUntil":"value","skipN":1}'

POST/api/plugins/schedule/:jobId/restore-native

Restore an adopted Bakin schedule back to its native runtime cron behavior

Operationschedule.post.job-id-restore-native
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
jobIdpathyes
{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/schedule/<jobId>/restore-native' \
-H 'Content-Type: application/json' \
--data '{"jobId":"value"}'

POST/api/plugins/schedule/:jobId/run

Trigger immediate run

Operationschedule.post.job-id-run
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
jobIdpathyes
{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/schedule/<jobId>/run' \
-H 'Content-Type: application/json' \
--data '{"jobId":"value"}'

GET/api/plugins/schedule/:jobId/runs

Get run history for a job

Operationschedule.get.job-id-runs
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
jobIdpathyes
limitqueryno

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/schedule/<jobId>/runs?limit=<limit>'

POST/api/plugins/schedule/bridge

Cron bridge webhook

Internal webhook the runtime cron POSTs to when a job fires. Auth via shared secret.

Operationschedule.post.bridge
Stabilitystable
Visibilityinternal

Parameters

NameInRequiredDescription
secretqueryno
{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    },
    "runId": {
      "type": "string"
    }
  },
  "required": [
    "jobId"
  ],
  "additionalProperties": {}
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/schedule/bridge?secret=<secret>' \
-H 'Content-Type: application/json' \
--data '{"jobId":"value","runId":"value"}'

POST/api/plugins/schedule/parse

Parse a schedule expression

Converts a natural-language or cron expression into structured schedule output.

Operationschedule.post.parse
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "input": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "input"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/schedule/parse' \
-H 'Content-Type: application/json' \
--data '{"input":"value"}'

GET/api/plugins/schedule/search

Search schedule

Full-text search across schedule indexed content.

Operationschedule.get.search
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
qqueryyes
limitqueryno
offsetqueryno
facetsqueryno

No request body.

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {}
    },
    "aggregations": {},
    "meta": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string"
        },
        "total": {
          "type": "number"
        },
        "took_ms": {
          "type": "number"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "query",
        "total",
        "took_ms",
        "source"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "results"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/schedule/search?q=<q>&limit=<limit>&offset=<offset>&facets=<facets>'
13 endpoints

GET/api/plugins/tasks/

List all tasks

Returns the full kanban board state, grouped by column.

Operationtasks.get.root
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/tasks/'

POST/api/plugins/tasks/

Create a task

Creates a task on the kanban board. Auto-matches a workflow by title when workflowId is omitted.

Operationtasks.post.root
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "description": {
      "type": "string"
    },
    "column": {
      "type": "string",
      "enum": [
        "backlog",
        "todo",
        "inProgress",
        "review",
        "done",
        "blocked",
        "archived"
      ]
    },
    "assignee": {
      "type": "string"
    },
    "workflowId": {
      "type": "string"
    },
    "skipWorkflowReason": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "parentId": {
      "type": "string"
    },
    "projectId": {
      "type": "string"
    }
  },
  "required": [
    "title"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    },
    "id": {
      "type": "string"
    },
    "workflowId": {
      "type": "string"
    },
    "suggestedWorkflow": {
      "type": "string"
    }
  },
  "required": [
    "ok",
    "id"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/tasks/' \
-H 'Content-Type: application/json' \
--data '{"id":"value","title":"value","description":"value","column":"backlog","assignee":"value","workflowId":"value","skipWorkflowReason":"value","createdBy":"value","parentId":"value","projectId":"value"}'

GET/api/plugins/tasks/:taskId

Get a task by ID

Operationtasks.get.task-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/tasks/<taskId>'

PUT/api/plugins/tasks/:taskId

Update a task

Operationtasks.put.task-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "originalTitle": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "agent": {
      "type": "string"
    },
    "column": {
      "type": "string"
    },
    "workflowId": {
      "type": "string"
    }
  },
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/tasks/<taskId>' \
-H 'Content-Type: application/json' \
--data '{"id":"value","originalTitle":"value","title":"value","description":"value","agent":"value","column":"value","workflowId":"value"}'

DELETE/api/plugins/tasks/:taskId

Delete a task

Operationtasks.delete.task-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    }
  },
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/plugins/tasks/<taskId>' \
-H 'Content-Type: */*' \
--data '{"id":"value","title":"value"}'

POST/api/plugins/tasks/:taskId/assign

Assign a task to an agent

Operationtasks.post.task-id-assign
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "agent": {
      "type": "string"
    }
  },
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/tasks/<taskId>/assign' \
-H 'Content-Type: application/json' \
--data '{"id":"value","title":"value","agent":"value"}'

POST/api/plugins/tasks/:taskId/block

Mark a task as blocked

Operationtasks.post.task-id-block
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "agent": {
      "type": "string"
    },
    "reason": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "reason"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/tasks/<taskId>/block' \
-H 'Content-Type: application/json' \
--data '{"id":"value","title":"value","agent":"value","reason":"value"}'

POST/api/plugins/tasks/:taskId/complete

Mark a task as complete

Operationtasks.post.task-id-complete
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agent": {
      "type": "string"
    },
    "summary": {
      "type": "string"
    }
  },
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/tasks/<taskId>/complete' \
-H 'Content-Type: application/json' \
--data '{"id":"value","agent":"value","summary":"value"}'

POST/api/plugins/tasks/:taskId/dependency

Set a dependency between tasks

Operationtasks.post.task-id-dependency
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "dependsOn": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "dependsOn"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/tasks/<taskId>/dependency' \
-H 'Content-Type: application/json' \
--data '{"id":"value","dependsOn":"value"}'

POST/api/plugins/tasks/:taskId/log

Add a log entry to a task

Operationtasks.post.task-id-log
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "author": {
      "type": "string"
    },
    "agent": {
      "type": "string"
    },
    "message": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "message"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/tasks/<taskId>/log' \
-H 'Content-Type: application/json' \
--data '{"id":"value","title":"value","author":"value","agent":"value","message":"value"}'

POST/api/plugins/tasks/:taskId/move

Move a task to a different column

Operationtasks.post.task-id-move
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "agent": {
      "type": "string"
    },
    "reason": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    }
  },
  "required": [
    "to",
    "agent"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/tasks/<taskId>/move' \
-H 'Content-Type: application/json' \
--data '{"id":"value","title":"value","from":"value","to":"value","agent":"value","reason":"value","channel":"value"}'

POST/api/plugins/tasks/reorder

Reorder tasks within a column

Operationtasks.post.reorder
Stabilitystable
Visibilitypublic
{
  "type": "object",
  "properties": {
    "columnId": {
      "type": "string",
      "minLength": 1
    },
    "orderedIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "columnId",
    "orderedIds"
  ],
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/tasks/reorder' \
-H 'Content-Type: application/json' \
--data '{"columnId":"value","orderedIds":["value"]}'

GET/api/plugins/tasks/search

Search tasks

Full-text search across tasks (title, description, log entries, blocked reasons).

Operationtasks.get.search
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
qqueryyes
limitqueryno
offsetqueryno
facetsqueryno

No request body.

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {}
    },
    "aggregations": {},
    "meta": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string"
        },
        "total": {
          "type": "number"
        },
        "took_ms": {
          "type": "number"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "query",
        "total",
        "took_ms",
        "source"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "results"
  ],
  "additionalProperties": false
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/tasks/search?q=<q>&limit=<limit>&offset=<offset>&facets=<facets>'
29 endpoints

GET/api/plugins/team/

List all agents with runtime status

List all agents with runtime status

Operationteam.get.root
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/'

POST/api/plugins/team/

Create a new agent in the active runtime

Create a new agent in the active runtime

Operationteam.post.root
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/team/'

GET/api/plugins/team/:agentId

Get full agent profile merged from runtime state

Get full agent profile merged from runtime state

Operationteam.get.agent-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>'

DELETE/api/plugins/team/:agentId

Remove an agent from the active runtime and move workspace to trash

Remove an agent from the active runtime and move workspace to trash

Operationteam.delete.agent-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/plugins/team/<agentId>'

GET/api/plugins/team/:agentId/active-context

Read the most recent session JSONL parsed into a message stream

Read the most recent session JSONL parsed into a message stream

Operationteam.get.agent-id-active-context
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/active-context'

GET/api/plugins/team/:agentId/avatar

Serve agent avatar image

Serve agent avatar image

Operationteam.get.agent-id-avatar
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/avatar'

POST/api/plugins/team/:agentId/avatar

Upload agent avatar image

Upload agent avatar image

Operationteam.post.agent-id-avatar
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/team/<agentId>/avatar'

GET/api/plugins/team/:agentId/files

List workspace files for an agent

List workspace files for an agent

Operationteam.get.agent-id-files
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/files'

GET/api/plugins/team/:agentId/files/:filename

Read a specific workspace file

Read a specific workspace file

Operationteam.get.agent-id-files-filename
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes
filenamepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/files/<filename>'

PUT/api/plugins/team/:agentId/files/:filename

Write a workspace file through the active runtime

Write a workspace file through the active runtime

Operationteam.put.agent-id-files-filename
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes
filenamepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/team/<agentId>/files/<filename>'

GET/api/plugins/team/:agentId/heartbeat

Read the agent heartbeat narrative

Read the agent HEARTBEAT.md narrative + file mtime

Operationteam.get.agent-id-heartbeat
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/heartbeat'

PUT/api/plugins/team/:agentId/identity

Update agent identity fields and persona files

Update agent identity fields and persona files

Operationteam.put.agent-id-identity
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/team/<agentId>/identity'

GET/api/plugins/team/:agentId/memory

List memory files for an agent

List memory files for an agent

Operationteam.get.agent-id-memory
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/memory'

GET/api/plugins/team/:agentId/memory/:date

Read a specific memory file

Read a specific memory file

Operationteam.get.agent-id-memory-date
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes
datepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/memory/<date>'

PUT/api/plugins/team/:agentId/permissions

Update agent dispatch permissions (subagents.allowAgents)

Update agent dispatch permissions (subagents.allowAgents)

Operationteam.put.agent-id-permissions
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/team/<agentId>/permissions'

GET/api/plugins/team/:agentId/recent-activity

Per-agent dispatch + error counts across 5m / 1h / 24h windows (resets on server restart)

Per-agent dispatch + error counts across 5m / 1h / 24h windows (resets on server restart)

Operationteam.get.agent-id-recent-activity
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/recent-activity'

GET/api/plugins/team/:agentId/skills

List installed skills for an agent

List installed skills for an agent

Operationteam.get.agent-id-skills
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/skills'

GET/api/plugins/team/:agentId/skills/:skillId

Read SKILL.md for a specific skill

Read SKILL.md for a specific skill

Operationteam.get.agent-id-skills-skill-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes
skillIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/skills/<skillId>'

POST/api/plugins/team/:agentId/start

Start an agent via the active runtime

Start an agent via the active runtime

Operationteam.post.agent-id-start
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/team/<agentId>/start'

GET/api/plugins/team/:agentId/stats

Get token usage and cost stats for an agent

Get token usage and cost stats for an agent

Operationteam.get.agent-id-stats
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/<agentId>/stats'

POST/api/plugins/team/:agentId/stop

Stop an agent

Stop an agent

Operationteam.post.agent-id-stop
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/team/<agentId>/stop'

PUT/api/plugins/team/:agentId/team

Assign an agent to an organizational team

Assign an agent to an organizational team

Operationteam.put.agent-id-team
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
agentIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/team/<agentId>/team'

GET/api/plugins/team/settings

Get agent display settings

Get agent display settings

Operationteam.get.settings
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/settings'

PUT/api/plugins/team/settings

Update agent display settings

Update agent display settings

Operationteam.put.settings
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/team/settings'

GET/api/plugins/team/teams

List organizational teams

List organizational teams

Operationteam.get.teams
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/teams'

POST/api/plugins/team/teams

Create an organizational team

Create an organizational team

Operationteam.post.teams
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/team/teams'

PUT/api/plugins/team/teams/:teamId

Update an organizational team

Update an organizational team

Operationteam.put.teams-team-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
teamIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/team/teams/<teamId>'

DELETE/api/plugins/team/teams/:teamId

Delete an organizational team

Delete an organizational team

Operationteam.delete.teams-team-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
teamIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/plugins/team/teams/<teamId>'

GET/api/plugins/team/teams/:teamId/members

List agents belonging to a team

List agents belonging to a team

Operationteam.get.teams-team-id-members
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
teamIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/team/teams/<teamId>/members'
18 endpoints

GET/api/plugins/workflows/definitions

List all workflow templates with step counts and resolved sub-workflows

List all workflow templates with step counts and resolved sub-workflows

Operationworkflows.get.definitions
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/definitions'

POST/api/plugins/workflows/definitions

Create a new user-owned workflow definition

Create a new user-owned workflow definition

Operationworkflows.post.definitions
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/workflows/definitions'

GET/api/plugins/workflows/definitions/:name

Get a specific workflow definition by name

Get a specific workflow definition by name

Operationworkflows.get.definitions-name
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
namepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/definitions/<name>'

PUT/api/plugins/workflows/definitions/:name

Update or shadow a workflow definition (writes user YAML)

Update or shadow a workflow definition (writes user YAML)

Operationworkflows.put.definitions-name
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
namepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X PUT \
'http://localhost:3737/api/plugins/workflows/definitions/<name>'

DELETE/api/plugins/workflows/definitions/:name

Delete a user-owned workflow definition

Delete a user-owned workflow definition

Operationworkflows.delete.definitions-name
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
namepathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X DELETE \
'http://localhost:3737/api/plugins/workflows/definitions/<name>'

POST/api/plugins/workflows/gates/:taskId/approve

Approve a human gate step

Approve a human gate step

Operationworkflows.post.gates-task-id-approve
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/workflows/gates/<taskId>/approve'

GET/api/plugins/workflows/gates/:taskId/decision

Render a durable Bakin gate approval fallback page

Render a durable Bakin gate approval fallback page

Operationworkflows.get.gates-task-id-decision
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/gates/<taskId>/decision'

POST/api/plugins/workflows/gates/:taskId/decision

Approve or reject a gate through the durable Bakin approval fallback page

Approve or reject a gate through the durable Bakin approval fallback page

Operationworkflows.post.gates-task-id-decision
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/workflows/gates/<taskId>/decision'

POST/api/plugins/workflows/gates/:taskId/reject

Reject a gate step, rewinds workflow

Reject a gate step, rewinds workflow

Operationworkflows.post.gates-task-id-reject
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/workflows/gates/<taskId>/reject'

GET/api/plugins/workflows/gates/pending

List all gates awaiting approval

List all gates awaiting approval

Operationworkflows.get.gates-pending
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/gates/pending'

GET/api/plugins/workflows/gates/status

Batch check gate status for tasks

Batch check gate status for tasks

Operationworkflows.get.gates-status
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/gates/status'

GET/api/plugins/workflows/instances

List active workflow instances. Optional status filter.

List active workflow instances. Optional status filter.

Operationworkflows.get.instances
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/instances'

GET/api/plugins/workflows/instances/:taskId

Get full workflow instance state for a task

Get full workflow instance state for a task

Operationworkflows.get.instances-task-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/instances/<taskId>'

POST/api/plugins/workflows/instances/start

Start a workflow instance for a task

Start a workflow instance for a task

Operationworkflows.post.instances-start
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/workflows/instances/start'

GET/api/plugins/workflows/node-types

List registered workflow node types (builtin + plugin-registered) for the canvas palette

List registered workflow node types (builtin + plugin-registered) for the canvas palette

Operationworkflows.get.node-types
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/node-types'

GET/api/plugins/workflows/notification-channels

List registered notification channels

List registered notification channels

Operationworkflows.get.notification-channels
Stabilitystable
Visibilitypublic

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/notification-channels'

GET/api/plugins/workflows/steps/:taskId

Get current workflow step for a task

Get current workflow step for a task

Operationworkflows.get.steps-task-id
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
'http://localhost:3737/api/plugins/workflows/steps/<taskId>'

POST/api/plugins/workflows/steps/:taskId/complete

Submit step output, validates against schema, advances workflow

Submit step output, validates against schema, advances workflow

Operationworkflows.post.steps-task-id-complete
Stabilitystable
Visibilitypublic

Parameters

NameInRequiredDescription
taskIdpathyes

No request body.

{
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Terminal window
curl -sS \
-X POST \
'http://localhost:3737/api/plugins/workflows/steps/<taskId>/complete'