FAQ

Stream an AI FAQ response

/ai/faq

Submits a question to the AI FAQ service and receives a Server-Sent Events (SSE) response. The stream emits exactly one event then closes.

Each event uses the following wire format:

event: <event-name>
data: <json-encoded-payload>

Events

Event	When	Data shape
`complete`	Always	See below
`error`	Stream interrupted	`{"message": "..."}`

Complete

Field	Type	Description
`conversation_id`	string (UUIDv4)	ID of the conversation (new or existing).
`faq`	object \\| absent	Present only when a matching FAQ entry was found within the relevance threshold.
`faq.id`	string	Vector store ID of the matched FAQ entry.
`faq.question`	string	The matched FAQ question.
`faq.answer`	string	The matched FAQ answer.
`faq.actionUrl`	string \\| null	Optional CTA URL associated with the FAQ.
`faq.actionText`	string \\| null	Optional CTA label associated with the FAQ.

Example — match found:

event: complete
data: {"conversation_id":"550e8400-e29b-41d4-a716-446655440000","faq":{"id":"faq_001","question":"How do I submit a claim?","answer":"Log in to the portal and select Claims.","actionUrl":"/claims","actionText":"Go to Claims"}}

Example — no match:

event: complete
data: {"conversation_id":"550e8400-e29b-41d4-a716-446655440000"}

Request parameters

{
  "message": "What is the process for submitting a claim?",
  "conversation": "550e8400-e29b-41d4-a716-446655440000"
}

Responses

01 September 2026