Chat (SSE) - BeforeQuery

Stream a citation-backed answer for a user’s question.

POST https://api.agents.beforequery.com/api/v1/public/projects/:projectId/chat

Auth: client key. Response: text/event-stream.

Request body

Field	Type	Required	Description
`query`	`string`	Yes	The user’s question
`thread_id`	`string`	No	Continue an existing conversation thread
`group_ids`	`string[]`	No	Scope retrieval to source groups; intersected with the key’s `allowed_groups` (403 if a group is outside the project or the allowed set)
`user`	`{ email?, id? }`	No	End-user identity for analytics

curl -N https://api.agents.beforequery.com/api/v1/public/projects/proj_xxx/chat \
  -H "X-Client-Key: bq_pk_..." \
  -H "Content-Type: application/json" \
  -d '{"query": "How does OAuth work?"}'

Response stream

Token deltas stream first, then a final event carries thread_id, message_id, and citations:

event: token
data: {"content": "OAuth in "}

event: token
data: {"content": "this product uses ..."}

event: citations
data: {"citations": [{"index": 1, "url": "https://docs.example.com/oauth", "title": "OAuth Guide", "document_id": "doc_uuid"}]}

event: done
data: {"thread_id": "thr_uuid", "message_id": "msg_uuid"}

Citations map to [n] markers in the answer text — render them as numbered source links.

Continuing a conversation

Either pass thread_id in the project chat body, or post to the thread endpoint:

POST https://api.agents.beforequery.com/api/v1/public/threads/:threadId/chat

Same body and stream format. Conversation memory includes recent turns, so follow-ups like “what about SSO?” resolve correctly.

CAPTCHA

Keys with require_captcha must include X-Captcha-Token: <reCAPTCHA v3 token>. See Authentication.

Notes

Restricted documents are never retrieved by public chat.
When retrieval finds nothing relevant, the assistant says it doesn’t know rather than guessing — answers are generated only from retrieved sources.
Prefer WebSocket? See the WebSocket transport — the SDK uses it by default with SSE fallback.

​Request body

​Response stream

​Continuing a conversation

​CAPTCHA

​Notes

Request body

Response stream

Continuing a conversation

CAPTCHA

Notes