Skip to content
nikcli
Docs
Documentation

Questions

Questions an agent has asked the user, and the reply or rejection that unblocks it.

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

const client = createNikcliClient()
await client.question.list({
  ...
})
Try it
post /question/{requestID}/reply # question.reply
Parameters
Name In Type Required
requestID path string required
directory query string optional
workspace query string optional
Request body · required · application/json 
{
  answers: QuestionAnswer[]
}
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
question.reply
ts 
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.question.reply({
  ...
})
Try it
post /question/{requestID}/reject # question.reject
Parameters
Name In Type Required
requestID path string required
directory query string optional
workspace query string optional
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
question.reject
ts 
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.question.reject({
  ...
})
Try it

Schemas

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

QuestionAnswer
string[]
QuestionInfo_1
{
  question: string
  header: string
  options: QuestionOption_1[]
  multiple?: boolean | null
  custom?: boolean | null
}
QuestionOption_1
{
  label: string
  description: string
}
QuestionReply
{
  answers: QuestionAnswer[]
}
QuestionRequest_1
{
  id: string
  sessionID: string
  questions: QuestionInfo_1[]
  tool?: 
    | {
    messageID: string
    callID: string
  }
    | null
}