# Health & Doctor

Server health, global dispose, and the doctor report that checks the install end to end.

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

3 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-doctor">/doctor</a></td><td class="api-index-id">doctor.run</td></tr><tr><td class="api-index-method"><span class="api-method api-method-get">get</span></td><td><a href="#op-get-global-health">/global/health</a></td><td class="api-index-id">global.health</td></tr><tr><td class="api-index-method"><span class="api-method api-method-post">post</span></td><td><a href="#op-post-global-dispose">/global/dispose</a></td><td class="api-index-id">global.dispose</td></tr></tbody></table>

get /doctor [#](#op-get-doctor) `doctor.run`

Parameters

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

Responses

200 DoctorReport application/json

{
  ok: boolean
  version: string
  channel: string
  failures: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  results: [DoctorCheck](#schema-DoctorCheck)\[\]
}

Example response from schema

{
  "ok": false,
  "version": "",
  "channel": "",
  "failures": 0,
  "results": \[
    {
      "ok": false,
      "label": "",
      "detail": "",
      "fix": ""
    }
  \]
}

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

SDK example

doctor.run

ts 

1

2

3

4

5

6

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

const client = createNikcliClient()
await client.doctor.run({
  ...
})
```

Try it

directory _query_  workspace _query_

---

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