Ask / chat generative answer stream. The client opens this channel by
issuing `POST /v1/kb/{kbid}/ask` with `Content-Type: application/json` and
a JSON body containing the question. Unless `X-Synchronous: true` is set,
the server responds with `Content-Type: application/x-ndjson` and emits an
ordered sequence of JSON items: an initial retrieval-results item, then
one or more answer-chunk items as
kbid — Unique identifier of the Knowledge Box being queried.
Operations
subscribe
streamAskItems
Subscribe to streamed ask / chat answer items (HTTP ndjson).
Messages
RetrievalItem
The context retrieved (find results) used to ground the generative answer.
Content-Type: application/json
AnswerChunk
An incremental slice of the generated answer text.
Content-Type: application/json
CitationsItem
Mapping of cited resources / paragraphs supporting the answer.
Content-Type: application/json
StatusItem
Final item carrying the completion status and a learning id.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.