Skip to content
nikcli
Docs
Documentation

Permissions

Pending permission requests and the reply that approves or denies one.

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

3 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 /permission permission.list
get /permission/blocked permission.blocked
post /permission/{requestID}/reply permission.reply
get /permission # permission.list
Parameters
Name In Type Required
directory query string optional
workspace query string optional
Responses
200 Success application/json 
({
  id: string
  sessionID: string
  permission: string
  patterns: string[]
  metadata: { [key: string]: unknown }
  always: string[]
  tool?: 
    | {
    messageID: string
    callID: string
  }
    | null
})[]
Example response captured 
[]
SDK example
permission.list
ts 
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.permission.list({
  ...
})
Try it
get /permission/blocked # permission.blocked
Parameters
Name In Type Required
directory query string optional
workspace query string optional
Responses
200 Success application/json 
({
  id: string
  sessionID: string
  permission: string
  patterns: string[]
  rule: string
  reason: string
  time: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  tool?: 
    | {
    messageID: string
    callID: string
  }
    | null
})[]
Example response from schema 
[
  {
    "id": "",
    "sessionID": "",
    "permission": "",
    "patterns": [
      ""
    ],
    "rule": "",
    "reason": "",
    "time": 0,
    "tool": {
      "messageID": "",
      "callID": ""
    }
  }
]

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

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

const client = createNikcliClient()
await client.permission.blocked({
  ...
})
Try it
post /permission/{requestID}/reply # permission.reply
Parameters
Name In Type Required
requestID path string required
directory query string optional
workspace query string optional
Request body · required · application/json 
{
  reply: PermissionReply
  message?: string | null
}
Responses
200 Success application/json 
boolean
Example response from schema 
false

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

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

const client = createNikcliClient()
await client.permission.reply({
  ...
})
Try it

Schemas

The 4 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.

PermissionBlocked
{
  id: string
  sessionID: string
  permission: string
  patterns: string[]
  rule: string
  reason: string
  time: 
    | number
    | "Infinity" | "-Infinity" | "NaN"
  tool?: 
    | {
    messageID: string
    callID: string
  }
    | null
}
PermissionReply
"once" | "always" | "reject"
PermissionReplyInput
{
  reply: PermissionReply
  message?: string | null
}
PermissionRequest_1
{
  id: string
  sessionID: string
  permission: string
  patterns: string[]
  metadata: { [key: string]: unknown }
  always: string[]
  tool?: 
    | {
    messageID: string
    callID: string
  }
    | null
}