AI Chat

Get AI-powered conversational answers grounded in your search index.

POST /api/v4/{customerId}/{engineId}/search/answer

AI Chat

cURL

curl --request POST \
  --url https://api.cludo.com/api/v4/{customerId}/{engineId}/search/answer \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "<string>",
  "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "language": "<string>",
  "customPrompt": "<string>",
  "includeCitations": true
}
'

200

{
  "value": {
    "answer": "<string>",
    "url": "<string>",
    "chatSessionId": "<string>",
    "conversationId": "<string>",
    "exchangeId": "<string>",
    "citations": [
      {
        "reference": 123,
        "url": "<string>",
        "pageTitle": "<string>"
      }
    ],
    "couldAnswer": true
  }
}

Standard

You are viewing the standard endpoint which returns a complete JSON response.

Streaming

The streaming endpoint is the same path as standard with /stream appended: POST /api/v4/{customerId}/{engineId}/search/answer/stream. It accepts the same request body as the standard endpoint, but streams the response as plain text chunks. Citations are included inline in the streamed text by default, so includeCitations does not change the streaming response. Response headers include Cludo-Conversation-Id and Cludo-Exchange-Id for conversation tracking.

---

Multi-turn Conversations

Pass the conversationId from a previous response to continue the conversation. For independent questions, omit conversationId to start fresh.

---

Authorizations

SiteKeyBasicAuth

Authorization · string · header · required

SiteKey authentication. Pass the full value including the SiteKey prefix: SiteKey <base64(customerId:engineId:searchKey)>. Example: SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1.

Path Parameters

customerId · integer · required

Your Cludo account ID.

engineId · integer · required

Search engine ID.

Body

application/json

question · string · required

End-user question in natural language. Grounding content is retrieved from your indexed pages.

conversationId · string<uuid>

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).

language · string

ISO-639-1 or simple locale code for answer language (e.g. en, da).

answerLength · enum<string>

comprehensive for longer explanations; concise for short answers.

Available options: comprehensive, concise

customPrompt · string

Extra system-style instructions (tone, disclaimers, formatting). Use sparingly; overrides can affect safety and quality.

includeCitations · boolean

For non-streaming AI Chat, when true, the JSON response includes citations with title, url, and snippet for each source used. For streaming AI Chat, citations are included inline in the streamed text by default and this flag does not change the streamed output. Server default: False.

Response

200

application/json

Successful AI Chat response.

value · object

Show child attributes