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.
Which version should I use?
| Scenario | Recommendation |
|---|
| New integration | Use v4 paths for search, autocomplete, AI Chat, AI Summary, and index management. |
| Existing v3 integration | Your code continues to work. See API Versions for guidance. |
| Search Tools | Banners, rankings, quicklinks, and synonyms use unversioned /api/ paths. |
Base URLs
| Region | Base URL | Customer IDs |
|---|
| EU | https://api.cludo.com | Below 10,000,000 |
| US | https://api-us1.cludo.com | 10,000,000 and above |
Authentication
| Scheme | When to use |
|---|
| SiteKey | Search, Autocomplete, AI Chat, AI Summary, Tracking |
| Basic (API Key) | Index management (PUT/PATCH/DELETE), queue URLs, search tools, bulk-delete |
| Anonymous | Tracking, AI feedback and click tracking |
Endpoint Index
Search
| Endpoint | Path | Auth | Description |
|---|
| Search | POST /api/v4/{customerId}/{engineId}/search | SiteKey, Basic | Full-text search with filters, facets, and sorting |
| Autocomplete | GET /api/v4/{customerId}/{engineId}/autocomplete | SiteKey, Basic | Typeahead suggestions for search inputs |
| Endpoint | Path | Auth | Description |
|---|
| AI Chat | POST .../search/answer | SiteKey, Basic | AI-powered conversational answers (standard and streaming) |
| AI Summary | POST .../search/summarize | SiteKey, Basic | Summarize search results with AI |
| AI Summary | POST .../search/summarize/stream | SiteKey, Basic | Streaming variant of AI Summary |
Content & Indexing
| Endpoint | Path | Auth | Description |
|---|
| Index Management | PUT/PATCH/DELETE .../index/{crawlerId}/documents | Basic | Push, update, and delete documents |
| Queue URLs | POST .../crawler/{crawlerId}/paths | Basic | Queue URLs for crawling |
| Bulk Delete | POST .../documents/bulk-delete | Basic | Delete documents matching a filter |
Tracking
| Endpoint | Path | Auth | Description |
|---|
| Track Search Query | POST /api/v3/.../pushstat/querylog | Any (incl. Anonymous) | Record search queries for analytics |
| Track Result Click | POST /api/v3/.../pushstat/clicklog | Any (incl. Anonymous) | Record result clicks for analytics |
| Endpoint | Path | Auth | Description |
|---|
| Banners | /api/banners | Basic | Promote content in search results |
| Rankings | /api/rankings | Basic | Pin pages to top of search results |
| Quicklinks | /api/quicklinks | Basic | Redirect on specific search terms |
| Synonyms | /api/synonymsgroup | Basic | Define term equivalence groups |
v4-only Features
These capabilities have no v3 equivalent:
- AI Chat and AI Summary: conversational answers and document summarization powered by LLMs
- Index Management: replace, patch, and bulk-delete documents with advanced filtering (replaces v3 Content Management)
