# 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): This reference covers the Cludo API endpoints available for integration. Endpoints are organized by capability, with version badges indicating which API path each endpoint uses.
- [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.
- [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): Get AI-powered conversational answers grounded in your search index.
- [AI Search Overview](https://docs.cludo.com/api-reference/v4/ai/overview.md): Why AI-powered search delivers more accurate and relevant results, and how to get started with Cludo's AI features.
- [AI Summary](https://docs.cludo.com/api-reference/v4/ai/summary.md): Summarize search results with AI.
- [Autocomplete](https://docs.cludo.com/api-reference/v4/search/autocomplete.md): Get typeahead suggestions for search inputs.
- [Search](https://docs.cludo.com/api-reference/v4/search/search.md): Execute full-text search queries with filters, facets, and sorting.
- [Authentication](https://docs.cludo.com/authentication.md): Learn how to authenticate with the Cludo API using Basic or SiteKey authentication.
- [Crawler](https://docs.cludo.com/concepts/crawler.md): A crawler is the content source that feeds documents into an engine's index.
- [Document and Fields](https://docs.cludo.com/concepts/document-and-fields.md): How indexed content is structured for search.
- [Engine](https://docs.cludo.com/concepts/engine.md): A search engine is the configuration that powers a single search experience.
- [Search Template](https://docs.cludo.com/concepts/search-template.md): Pre-built Cludo solutions that combine a search input with a results display.
- [FAQ](https://docs.cludo.com/faq.md): Frequently asked questions about the Cludo API.
- [AI Integration Guide](https://docs.cludo.com/guides/ai-chat-integration.md): Add AI-powered answers and summaries to your search experience.
- [Analytics Guide](https://docs.cludo.com/guides/analytics.md): Track and analyze search performance with Cludo analytics.
- [API Versions: v3 vs v4](https://docs.cludo.com/guides/migration-v3-to-v4.md): Which API version to use for each Cludo feature.
- [Pushing Content](https://docs.cludo.com/guides/pushing-content.md): Push custom content to your Cludo search index via the API.
- [Introduction](https://docs.cludo.com/introduction.md): The unified Cludo API documentation: search, AI, crawlers, analytics, and more.
- [Quickstart](https://docs.cludo.com/quickstart.md): Make your first Cludo API call within a few minutes.
- [Regions](https://docs.cludo.com/regions.md): Cludo API regions, base URLs, and how to determine your region.
- [Troubleshooting](https://docs.cludo.com/troubleshooting.md): Solutions for common Cludo API errors and integration issues.

## OpenAPI Specs

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