Skip to main content
POST
/
api
/
v4
/
{customerId}
/
{engineId}
/
search
/
summarize
AI Summary
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": [
    {
      "id": "https://help.cludo.com/...",
      "fields": [
        "Title",
        "Content"
      ]
    }
  ],
  "language": "<string>",
  "customPrompt": "<string>",
  "includeCitations": true
}
'
{
  "value": {
    "summary": "<string>",
    "summaryRequestId": "<string>",
    "summaryId": "<string>",
    "summarySourceUrls": [
      "<string>"
    ]
  }
}
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.

​
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
  • 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.

​
Feature availability

answerLength and customPrompt are in limited availability. These options are currently in an early test phase and are only enabled for select customers running on specific servers. They are not active by default, so supplying these values will not change the generated output unless the features have been enabled for your account.To discuss enabling them for your setup, contact your account manager and share your customer ID and engine ID.
includeCitations applies to the streaming endpoint only. This parameter has no effect on the standard summary response. Use the streaming endpoint (/search/summarize/stream) if you need source URLs included in the output.

Authorizations

​
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
Example:
[
  {
    "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. Limited availability: this feature is currently in an early test phase and is only enabled for select customers on specific servers. It is not active by default, so the value has no effect unless it has been enabled for your account. Contact your account manager (with your customer ID and engine ID) to discuss enabling it.

Available options:
comprehensive,
concise
​
customPrompt
string

Optional extra instructions (e.g. “focus on steps”). Limited availability: this feature is currently in an early test phase and is only enabled for select customers on specific servers. It is not active by default, so the value has no effect unless it has been enabled for your account. Contact your account manager (with your customer ID and engine ID) to discuss enabling it.

​
includeCitations
boolean

When true, include source URLs in the value object (summarySourceUrls). Streaming only: this parameter applies only to the streaming endpoint (/search/summarize/stream) and has no effect on the standard summary response.

Response

AI Summary generated successfully.

​
value
object