AI Summary

Summarize search results with AI.

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

AI Summary

cURL

curl --request POST \
  --url https://api.cludo.com/api/v4/{customerId}/{engineId}/search/summarize \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "queryId": "<string>",
  "sources": [
    {
      "resultIndex": 1,
      "id": "https://help.cludo.com/...",
      "fields": [
        "Title",
        "Content"
      ]
    }
  ],
  "language": "<string>",
  "customPrompt": "<string>",
  "includeCitations": true
}
'

200

{
  "value": {
    "summary": "<string>",
    "summaryRequestId": "<string>",
    "summaryId": "<string>",
    "summarySourceUrls": [
      "<string>"
    ]
  }
}

Standard

You are viewing the standard endpoint which returns a complete JSON response. Generate AI-powered summaries from search result documents. The AI Summary endpoint works in tandem with the Search endpoint: first execute a search, then pass the search results as sources to generate a concise summary with citations.

Streaming

The streaming endpoint is the same path as standard with /stream appended: POST /api/v4/{customerId}/{engineId}/search/summarize/stream. It accepts the same request body as the standard endpoint, but streams the response as chunked plain text. Streaming responses set Cludo-Summary-Id and Cludo-Summary-Request-Id headers for tracking.

---

Workflow

Step 1: Execute a search

Call the Search endpoint and extract from the response:

• QueryId → use as the queryId parameter
• TypedDocuments[].Fields.Id.Value → use as the id for each source
• TypedDocuments[].ResultIndex → use as the resultIndex for each source
• Source fields → prefer Title and Content when those fields are available

Step 2: Generate the summary

Pass the extracted values to this endpoint along with your query and source configuration. Send no more than 5 sources.

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

query · string · required

Original user query string from search (for context and analytics).

queryId · string · required

Must equal QueryId from the search response that produced sources.

sources · object[] · required

One entry per result row to fold into the summary (typically the checked results on the SERP). Include at least three sources and no more than five.

Maximum array length: 5

Show child attributes

Example:

[
  {
    "resultIndex": 1,
    "id": "https://help.cludo.com/...",
    "fields": ["Title", "Content"]
  }
]

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 shorter summaries.

Available options: comprehensive, concise

customPrompt · string

Optional extra instructions (e.g. “focus on steps”).

includeCitations · boolean

When true, include source URLs in the value object (summarySourceUrls).

Response

200

application/json

AI Summary generated successfully.

value · object

Show child attributes