BrainAPI
BrainAPI
ReferenceCore API

For the complete BrainAPI documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL. Docs MCP: /docs/mcp.

BrainAPI System API

Administer brains with a system personal access token.

Create Brain

POST
/system/brains

Create a new brain

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for the create brain endpoint.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/system/brains" \  -H "Content-Type: application/json" \  -d '{    "brain_id": "string"  }'
{  "id": "string",  "name_key": "string",  "pat": "string"}

Get Brains List

GET
/system/brains-list

Get the list of brains.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/system/brains-list"
[  {    "id": "string",    "name_key": "string",    "pat": "string"  }]

Delete Brain

DELETE
/system/brains/{brain_id}

Delete a brain's data, registry identity, PAT, and cached credentials.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Path Parameters

brain_id*Brain Id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/system/brains/string"
{  "brain_id": "string",  "cleared_backends": [    "string"  ],  "existed": true,  "operation": "clear",  "success": true}

Clear Brain

POST
/system/brains/{brain_id}/clear

Clear all data for a brain while preserving its identity and PAT.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Path Parameters

brain_id*Brain Id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/system/brains/string/clear"
{  "brain_id": "string",  "cleared_backends": [    "string"  ],  "existed": true,  "operation": "clear",  "success": true}
Edit on GitHub

Tasks

Previous Page

Errors and HTTP statuses

Next Page