Skip to content
nikcli
Docs
Documentation

Events

Server-sent event feeds. One feed is scoped to the resolved instance, the other spans every instance the server hosts.

Playground

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

Not connected
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.

Operations

2 endpoints, generated from the server's own OpenAPI document. Every path also accepts the directory and workspace query parameters that select which instance handles the request.

get /event event.subscribe
get /global/event global.event
get /event # event.subscribe
Parameters
Name In Type Required
directory query string optional
workspace query string optional
Responses
200 Success text/event-stream 
{
  id: string | null
  event: string
  data: string
}
Example response from schema 
{
  "id": "",
  "event": "",
  "data": ""
}

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

SDK example
event.subscribe
ts 
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.event.subscribe({
  ...
})
Try it
get /global/event # global.event
Parameters
Name In Type Required
directory query string optional
workspace query string optional
Responses
200 Success text/event-stream 
{
  id: string | null
  event: string
  data: string
}
Example response from schema 
{
  "id": "",
  "event": "",
  "data": ""
}

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

SDK example
global.event
ts 
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.global.event({
  ...
})
Try it

Schemas

The 2 schemas reachable from these endpoints. Each is shown one level deep; nested types link to their own entry below. Names ending in _2, _3 and so on are the OpenAPI emitter disambiguating same-named schemas declared by different HttpApi groups — they are distinct shapes, not duplicates.

EventEncoded
string
GlobalEventEncoded
string