Ask the documentation a natural-language question (NLWeb)

Microsoft NLWeb ask endpoint over the Atisbo documentation. Send {"query": "…"} and get _meta plus an array of matching doc pages (url, name, site, score, description). Set streaming: true for the v0.55 SSE event framing (start → result per hit → complete); an Accept: text/event-stream header opts GET-style clients in too. RETRIEVAL ONLY: mode=list semantics always apply — asking for summarize/generate returns the same ranked list with _meta.limitations stating that nothing is generated.

post/api/ask

Request

  • Base URL: https://app.atisbo.dev
  • URL: https://app.atisbo.dev/api/ask
  • Auth: none declared

Request body

querystring required
streamingboolean

Respond with NLWeb v0.55 SSE events instead of one JSON object.

mode'list' | 'summarize' | 'generate'

Only list does anything; the other values are answered honestly with list output.

max_resultsinteger
query_idstring

Client-supplied correlation id; generated when omitted.

Response

The answer — one JSON object, or an SSE stream when streaming was requested.

query_idstring

Example response

{
  "_meta": {
    "version": "0.55",
    "response_type": "answer"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.