# Discord

Discord integration status, first-time setup, and the start/stop control.

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

4 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-discord">/discord</a></td><td class="api-index-id">discord.status</td></tr><tr><td class="api-index-method"><span class="api-method api-method-post">post</span></td><td><a href="#op-post-discord-setup">/discord/setup</a></td><td class="api-index-id">discord.setup</td></tr><tr><td class="api-index-method"><span class="api-method api-method-post">post</span></td><td><a href="#op-post-discord-start">/discord/start</a></td><td class="api-index-id">discord.start</td></tr><tr><td class="api-index-method"><span class="api-method api-method-post">post</span></td><td><a href="#op-post-discord-stop">/discord/stop</a></td><td class="api-index-id">discord.stop</td></tr></tbody></table>

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

Parameters

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

Responses

200 DiscordStatus application/json

{
  configured: boolean
  running: boolean
  username?: string
  clientId?: string
  inviteUrl?: string
  error?: string
}

Example response from schema

{
  "configured": false,
  "running": false,
  "username": "",
  "clientId": "",
  "inviteUrl": "",
  "error": ""
}

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

SDK example

discord.status

ts 

1

2

3

4

5

6

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

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

Try it

directory _query_  workspace _query_

---

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