> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cludo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Overview

> Reference for Cludo API endpoints covering search, autocomplete, AI answers, indexing, and analytics, organized by capability with v3 and v4 badges.

## 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](/guides/migration-v3-to-v4) 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 |

[Full region details](/regions)

## 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                                   |

[Full authentication guide](/authentication)

***

## Endpoint index

### Search

| Endpoint                                              | Path                                               | Auth           | Description                                        |
| ----------------------------------------------------- | -------------------------------------------------- | -------------- | -------------------------------------------------- |
| [Search](/api-reference/v4/search/search)             | `POST /api/v4/{customerId}/{engineId}/search`      | SiteKey, Basic | Full-text search with filters, facets, and sorting |
| [Autocomplete](/api-reference/v4/search/autocomplete) | `GET /api/v4/{customerId}/{engineId}/autocomplete` | SiteKey, Basic | Typeahead suggestions for search inputs            |

### AI

| Endpoint                                   | Path                               | Auth           | Description                                                |
| ------------------------------------------ | ---------------------------------- | -------------- | ---------------------------------------------------------- |
| [AI Chat](/api-reference/v4/ai/chat)       | `POST .../search/answer`           | SiteKey, Basic | AI-powered conversational answers (standard and streaming) |
| [AI Summary](/api-reference/v4/ai/summary) | `POST .../search/summarize`        | SiteKey, Basic | Summarize search results with AI                           |
| [AI Summary](/api-reference/v4/ai/summary) | `POST .../search/summarize/stream` | SiteKey, Basic | Streaming variant of AI Summary                            |

### Content & Indexing

| Endpoint                                                                        | Path                                               | Auth  | Description                        |
| ------------------------------------------------------------------------------- | -------------------------------------------------- | ----- | ---------------------------------- |
| [Index Management](/api-reference/v4/content/index-management)                  | `PUT/PATCH/DELETE .../index/{crawlerId}/documents` | Basic | Push, update, and delete documents |
| [Queue URLs](/api-reference/queue-urls)                                         | `POST .../crawler/{crawlerId}/paths`               | Basic | Queue URLs for crawling            |
| [Bulk Delete](/api-reference/v4/content/index-management#bulk-delete-documents) | `POST .../documents/bulk-delete`                   | Basic | Delete documents matching a filter |
|                                                                                 |                                                    |       |                                    |

### Tracking

| Endpoint                                                | Path                                 | Auth                  | Description                         |
| ------------------------------------------------------- | ------------------------------------ | --------------------- | ----------------------------------- |
| [Track Search Query](/api-reference/track-search-query) | `POST /api/v3/.../pushstat/querylog` | Any (incl. Anonymous) | Record search queries for analytics |
| [Track Result Click](/api-reference/track-result-click) | `POST /api/v3/.../pushstat/clicklog` | Any (incl. Anonymous) | Record result clicks for analytics  |

### Search Tools

| Endpoint                                                             | Path                 | Auth  | Description                        |
| -------------------------------------------------------------------- | -------------------- | ----- | ---------------------------------- |
| [Banners](/api-reference/list-banners-by-engine)                     | `/api/banners`       | Basic | Promote content in search results  |
| [Rankings](/api-reference/list-rankings-by-engine)                   | `/api/rankings`      | Basic | Pin pages to top of search results |
| [Quicklinks](/api-reference/list-quicklinks)                         | `/api/quicklinks`    | Basic | Redirect on specific search terms  |
| [Synonyms](/api-reference/get-synonyms-by-language-or-synonym-group) | `/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)
