# Cludo API Documentation

## Docs

- [AI Chat Click](https://docs.cludo.com/api-reference/ai-chat-click.md): Track citation or URL clicks from AI Chat results.
- [AI Chat Feedback](https://docs.cludo.com/api-reference/ai-chat-feedback.md): Submit thumbs-up/down style feedback for an AI chat exchange (`rating`: `positive` or `negative`), plus optional `reason`, `comment`, and `language`.
- [AI Summary Feedback](https://docs.cludo.com/api-reference/ai-summary-feedback.md): Submit feedback for an AI summary: `rating` (string), optional `reason` and `comment`.
- [Bulk Delete](https://docs.cludo.com/api-reference/bulk-delete.md): Deletes documents matching a set of filter predicates.
- [Create Banner](https://docs.cludo.com/api-reference/create-banner.md): Creates a banner. The server assigns `id`.
- [Create or Replace](https://docs.cludo.com/api-reference/create-or-replace.md): Create new documents or fully replace existing ones in the index. Send a JSON array of document objects; each document must include an `id` and a `fields` object. Common field names include Title, Url, Description, Date, Category, and Language.
- [Create Quicklink](https://docs.cludo.com/api-reference/create-quicklink.md): Creates a quicklink. The server assigns `id`.
- [Create Ranking](https://docs.cludo.com/api-reference/create-ranking.md): Creates a ranking. The server assigns `id`.
- [Create Synonym Group](https://docs.cludo.com/api-reference/create-synonym-group.md): Creates a synonym group.
- [Delete Banner](https://docs.cludo.com/api-reference/delete-banner.md): Deletes a banner by ID.
- [Delete Quicklink](https://docs.cludo.com/api-reference/delete-quicklink.md): Deletes a quicklink by ID.
- [Delete Ranking](https://docs.cludo.com/api-reference/delete-ranking.md): Deletes a ranking by ID.
- [Delete Synonym Group](https://docs.cludo.com/api-reference/delete-synonym-group.md): Deletes synonym groups. Pass comma-separated IDs in `groupIds`.
- [Get Quicklink](https://docs.cludo.com/api-reference/get-quicklink.md): Returns one quicklink by ID.
- [Get Quicklinks by Terms](https://docs.cludo.com/api-reference/get-quicklinks-by-terms.md): Returns quicklinks whose trigger terms match `searchword` for the given engine.
- [Get Single Banner](https://docs.cludo.com/api-reference/get-single-banner.md): Returns one banner by ID.
- [Get Single Ranking](https://docs.cludo.com/api-reference/get-single-ranking.md): Returns one ranking by ID.
- [Get Synonyms by Language or Synonym Group](https://docs.cludo.com/api-reference/get-synonyms-by-language-or-synonym-group.md): Path segment is overloaded: use a language code (for example `en`) to list all synonym groups for that language (`getSynonymsByLanguage`). Use a numeric synonym group ID to fetch a single group (`getSynonymGroup`).
- [List Banners by Engine](https://docs.cludo.com/api-reference/list-banners-by-engine.md): Returns all banners configured for the given search engine.
- [List Quicklinks](https://docs.cludo.com/api-reference/list-quicklinks.md): Returns all quicklinks for the given search engine.
- [List Rankings by Engine](https://docs.cludo.com/api-reference/list-rankings-by-engine.md): Returns all rankings configured for the given search engine.
- [API Reference Overview](https://docs.cludo.com/api-reference/overview.md): Reference for Cludo API endpoints covering search, autocomplete, AI answers, indexing, and analytics, organized by capability with v3 and v4 badges.
- [Partial Update](https://docs.cludo.com/api-reference/partial-update.md): Updates only the fields you send for each document. Request body is a JSON array of document objects in the same shape as replace; omit fields you do not want to change.
- [Queue URLs](https://docs.cludo.com/api-reference/queue-urls.md): Queues a list of URLs for the specified crawler. Request body must be a JSON array of URL strings.
- [Single Delete](https://docs.cludo.com/api-reference/single-delete.md): Deletes one document from the index by its document ID, supplied as the required `documentId` query parameter.
- [Submit Feedback](https://docs.cludo.com/api-reference/submit-feedback.md): Submit user feedback for search results including ratings and comments.
- [Track Result Click](https://docs.cludo.com/api-reference/track-result-click.md): Record when a user clicks a search result.
- [Track Search Query](https://docs.cludo.com/api-reference/track-search-query.md): Record a search query event for analytics.
- [Update Banner](https://docs.cludo.com/api-reference/update-banner.md): Replaces a banner. The banner `id` is taken from the URL path.
- [Update Quicklink](https://docs.cludo.com/api-reference/update-quicklink.md): Replaces a quicklink. The quicklink `id` is taken from the URL path.
- [Update Ranking](https://docs.cludo.com/api-reference/update-ranking.md): Replaces a ranking. The ranking `id` is taken from the URL path.
- [Update Synonym Group](https://docs.cludo.com/api-reference/update-synonym-group.md): Updates a synonym group.
- [AI Chat](https://docs.cludo.com/api-reference/v4/ai/chat.md): Returns a generative answer for the given question, with optional citations and multi-turn conversation support. For streaming AI Chat, citations are included inline in the streamed text by default, so `includeCitations` does not change the streamed output.
- [AI Search Overview](https://docs.cludo.com/api-reference/v4/ai/overview.md): Learn how Cludo AI Chat and AI Summary endpoints deliver generative answers and summaries grounded in your search index, and how to enable them.
- [AI Summary](https://docs.cludo.com/api-reference/v4/ai/summary.md): Generates a summary across selected search results for a given query.
- [Pre-search Suggestions](https://docs.cludo.com/api-reference/v4/search-tools/pre-search-suggestions.md): Fetch and render curated Pre-search Suggestions before a visitor starts typing in a custom search UI.
- [Autocomplete](https://docs.cludo.com/api-reference/v4/search/autocomplete.md): Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.
- [Search](https://docs.cludo.com/api-reference/v4/search/search.md): Execute a full-text search query with filters, facets, and sorting.
- [Authentication](https://docs.cludo.com/authentication.md): Authenticate Cludo API requests using HTTP Basic credentials or a SiteKey, including when to use each method and how to send the Authorization header.
- [Crawler](https://docs.cludo.com/concepts/crawler.md): Understand how Cludo crawlers discover, fetch, and feed website or feed content into an engine's index, and how crawl schedules and sources are configured.
- [Document and Fields](https://docs.cludo.com/concepts/document-and-fields.md): How Cludo structures indexed content as documents and fields, including standard fields, custom fields, and how field types affect search and filtering.
- [Engine](https://docs.cludo.com/concepts/engine.md): A Cludo engine groups the index, crawler, ranking, and configuration that powers one search experience. Learn how engines map to your sites and APIs.
- [Search Template](https://docs.cludo.com/concepts/search-template.md): Cludo search templates pair a search input with a results display, providing prebuilt layouts you can customize instead of building a UI from scratch.
- [FAQ](https://docs.cludo.com/faq.md): Answers to common questions about Cludo API authentication, rate limits, regions, v3 vs v4 endpoints, indexing, and AI search features.
- [AI Integration Guide](https://docs.cludo.com/guides/ai-chat-integration.md): Step-by-step guide to integrating Cludo AI Chat and AI Summary endpoints, including streaming responses, citations, and multi-turn conversations.
- [Analytics Guide](https://docs.cludo.com/guides/analytics.md): Track Cludo search queries, clicks, and search-as-you-type events to measure search performance and improve relevance using the analytics endpoints.
- [API Versions: v3 vs v4](https://docs.cludo.com/guides/migration-v3-to-v4.md): Compare Cludo API v3 and v4 endpoints, see which version supports each feature, and plan a migration from legacy v3 calls to the modern v4 API.
- [Pushing Content](https://docs.cludo.com/guides/pushing-content.md): Push custom documents into a Cludo search index using the Index Management API, including payload structure, batching, updates, and deletions.
- [Introduction](https://docs.cludo.com/introduction.md): Start here for the Cludo API: a unified reference covering search, autocomplete, AI answers, crawlers, indexing, and analytics across v3 and v4 endpoints.
- [Quickstart](https://docs.cludo.com/quickstart.md): Make your first Cludo API search call in minutes by setting up authentication, picking your region, and running a sample query against an engine.
- [Regions](https://docs.cludo.com/regions.md): Cludo API regions and base URLs for US and EU deployments, plus how to identify which region hosts your account so requests reach the right endpoint.
- [Troubleshooting](https://docs.cludo.com/troubleshooting.md): Diagnose common Cludo API issues including authentication failures, 401/403/404 errors, missing results, region mismatches, and indexing problems.

## OpenAPI Specs

- [search](https://docs.cludo.com/openapi/search.json)
- [index-management](https://docs.cludo.com/openapi/index-management.json)
- [ai](https://docs.cludo.com/openapi/ai.json)
- [feedback](https://docs.cludo.com/openapi/feedback.json)
- [tracking](https://docs.cludo.com/openapi/tracking.json)
- [search-tools](https://docs.cludo.com/openapi/search-tools.json)
- [openapi](https://docs.cludo.com/api-reference/openapi.json)