# Brain

Background learning status and the manual trigger that forces a pass.

Playground

Send these requests to your own running server. Values stay in this browser.

Not connected

Base URL  Directory _optional_  Bearer token _optional_ 

 

How this works

Start a server with `nikcli serve --hostname 127.0.0.1 --port 4096`. Requests go straight from this page to that address — the browser allows it because loopback counts as a secure origin, and the server allows it because `nikcli-ai.dev` is in its CORS allowlist.

To try things without touching your real sessions or config, start the server with `NIKCLI_TEST_HOME` pointed at a throwaway directory — see [the guided tour](/docs/guides/api-tour).

## Operations

2 endpoints, generated from the server's own [OpenAPI document](/docs/api). Every path also accepts the `directory` and `workspace` query parameters that select which instance handles the request.

<table class="api-index not-prose"><tbody><tr><td class="api-index-method"><span class="api-method api-method-get">get</span></td><td><a href="#op-get-brain">/brain</a></td><td class="api-index-id">brain.status</td></tr><tr><td class="api-index-method"><span class="api-method api-method-post">post</span></td><td><a href="#op-post-brain-trigger">/brain/trigger</a></td><td class="api-index-id">brain.trigger</td></tr></tbody></table>

get /brain [#](#op-get-brain) `brain.status`

Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| directory | query | string | optional |
| workspace | query | string | optional |

Responses

200 BrainStatus application/json

{
  enabled: boolean
  memoryEnabled: boolean
  minHours: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  minSessions: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  lastBrainAt: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  hoursSinceLastBrain: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  sessionsSinceLastBrain: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  shouldTrigger: boolean
  model?: 
    | {
    providerID: string
    modelID: string
  }
    | null
}

Example response from schema

{
  "enabled": false,
  "memoryEnabled": false,
  "minHours": 0,
  "minSessions": 0,
  "lastBrainAt": 0,
  "hoursSinceLastBrain": 0,
  "sessionsSinceLastBrain": 0,
  "shouldTrigger": false,
  "model": {
    "providerID": "",
    "modelID": ""
  }
}

Generated from the response schema — field values are placeholders, the shape is real.

SDK example

brain.status

ts 

1

2

3

4

5

6

```
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.brain.status({
  ...
})
```

Try it

directory _query_  workspace _query_

---

Source: https://nikcli-ai.dev/docs/api/brain