AI Chat
Returns a generative answer for the given question, with optional citations and multi-turn conversation support. includeCitations changes the output for both the standard and streaming endpoints.
- Standard
- Streaming
Multi-turn conversations
Pass theconversationId from a previous response to continue the conversation. For independent questions, omit conversationId to start fresh.
Authorizations
SiteKey authentication. Pass the full value including the SiteKey prefix: SiteKey <base64(customerId:engineId:searchKey)>. Example: SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1.
Path Parameters
Your Cludo account ID.
Search engine ID.
Body
End-user question in natural language. Grounding content is retrieved from your indexed pages.
Reuse the same id from a previous AI Chat response to continue a thread; omit or use a new id to start fresh (streaming responses expose ids in headers too).
ISO-639-1 or simple locale code for answer language (e.g. en, da).
comprehensive for longer explanations; concise for short answers.
comprehensive, concise Extra system-style instructions (tone, disclaimers, formatting). Use sparingly; overrides can affect safety and quality.
For non-streaming AI Chat, when true, the JSON response includes citations with title, url, and snippet for each source used, and url is left empty. When false (default), citations is omitted and url holds a single primary source link instead. For streaming AI Chat, when true, inline Markdown citation links are included in the streamed text. When false (default), the streamed text has no inline citations and a single primary source URL is surfaced separately. Server default: False.
Restrict the grounding content used to answer the question. Each key is an indexed field name mapped to allowed values (e.g. {"Category": ["Guides"]}). The reserved keys range, date, and geo_distance express numeric, date, and geo-distance filters — see the Search endpoint's Filter value formats for the full grammar.
Response
Successful AI Chat response.

