AsyncAPI channel · Contextual AI
· Contextual AI Agent Query Streaming (HTTP + SSE)
/agents/{agent_id}/query
Agent query SSE stream. The client opens this channel by issuing
`POST /agents/{agent_id}/query` with `Content-Type: application/json`
and a JSON body containing `stream: true`. The server responds with
`Content-Type: text/event-stream` and emits a sequence of `data:` lines
carrying grounded response token deltas, optional attribution and
retrieval events, and a final completion event.
A single SSE `data:` event carrying one delta of the grounded agent
response. Many of these are emitted per request, in order.
Content-Type: application/json
AttributionEvent
SSE event carrying inline attribution or retrieval-content metadata
for the grounded response.
Content-Type: application/json
QueryComplete
Terminal SSE event marking the end of the grounded response stream,
carrying the final message identifiers and groundedness scores.
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.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.