Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cludo.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through making your first search API call using the v4 API.
Prerequisites: You need a Cludo account with at least one engine configured. Sign in to MyCludo to get your credentials.

​
Step 1: Find your region

Your region is determined by your customer ID:
Customer IDRegionBase URL
Below 10,000,000EUhttps://api.cludo.com
10,000,000+UShttps://api-us1.cludo.com

​
Step 2: Get your credentials

Log in to MyCludo API settings and find the following values:
ValueWhere to find it
Customer IDDashboard → Account Settings
Engine IDDashboard → Engines → select your engine
API KeyMyCludo API settings

​
Step 3: Build your auth token

Unless an endpoint says otherwise, use Basic (API Key) authentication for Cludo API requests: 
# Format: base64(customerId:apiKey)
echo -n "3:c8fk2L9mK4pQ" | base64
# Output: MzpjOGZrMkw5bUs0cFE=
SiteKey authentication is available for public-facing search where you do not want to expose your API key. See the Authentication guide for SiteKey token format.

​
Try it: build your token

Use the tool below to generate a Basic or SiteKey authorization header and a ready-to-run cURL command. Basic authentication is the default choice unless you are building a public client-side search integration.
Keep Basic API keys private. Use the Basic examples from a trusted backend, script, or local test. For browser code, use SiteKey authentication instead.
curl -X POST "https://api.cludo.com/api/v4/3/6/search" \
  -H "Authorization: Basic MzpjOGZrMkw5bUs0cFE=" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "*",
    "page": 1,
    "perPage": 10
  }'

​
Step 5: Understand the response

{
  "typedDocuments": [
    {
      "fields": {
        "Title": "Getting Started Guide",
        "Description": "Learn how to set up Cludo search...",
        "Url": "https://example.com/getting-started"
      },
      "highlight": {
        "Title": "<b>Getting</b> <b>Started</b> Guide"
      },
      "id": "doc_123",
      "score": 15.7
    }
  ],
  "totalDocument": 42,
  "facets": {},
  "banners": [],
  "suggestions": [],
  "fixedQuery": null,
  "queryId": "abc-123-def",
  "generativeAnswerAvailable": true
}
FieldDescription
typedDocumentsArray of search results with field values and highlights
totalDocumentTotal number of matching documents
facetsFacet counts for filtering
fixedQuerySpell-corrected query (if applicable)
queryIdUnique identifier for this search request
generativeAnswerAvailableWhether AI Chat can answer this query

​
What’s next?

Search API (v4)

Complete search endpoint reference.

Analytics

Track searches and clicks.

Pushing Content

Push custom content to your search index.

Search Tools

Manage banners, rankings, quicklinks, and synonyms.