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.

v4 is the recommended API version for new search, AI, and index-management integrations.
API AreaVersion
Search & Autocompletev3 or v4 (both work)
AI Chat & AI Summaryv4 only
Index Managementv4 only
Trackingv3 only
Search ToolsUnversioned (/api/...)
The main migration work is Index Management: v3 Content Management uses /content/{crawlerId}/..., while v4 uses /index/{crawlerId}/documents. If you use PushURLs, the v4 equivalent is POST /api/v4/{customerId}/crawler/{crawlerId}/paths.See API Versions: v3 vs v4 for details. For the full v3 API reference, see the legacy documentation.

​
Architecture

ComponentRole
EngineHolds your search index. Every API call references a customerId and engineId.
CrawlerFetches and indexes your website on a schedule. Optional if you push all content via the Content API.
Content APILets you push, update, or delete documents directly — no crawling needed. Requires a crawlerId as an index container even if the crawler never actively crawls.
AnalyticsPopulated by tracking events sent from your frontend. Requires the analytics script or manual API calls — events are not sent automatically.
A Crawler and the Content API can coexist on the same engine. If you use both, be aware that a scheduled crawl can overwrite pushed content on the same URLs. If you push all content via API, disable scheduled crawling in MyCludo.
Use the filters parameter to include only results with matching field values:
{
  "query": "*",
  "filters": {
    "Category": ["Guides", "Tutorials"]
  }
}
You can filter on standard fields and custom crawler fields, as long as the field is available in your index and configured for filtering where required. Field names are case-sensitive, so use the exact field name from your crawler or pushed document configuration.To exclude values, use notFilters. To build filter UI counts, enable facets on the relevant fields and send enableFacetFiltering: true.See the Search API reference for request parameters.
Use the Cludo API analytics script or send tracking events through the API. Query tracking uses POST /api/v3/{customerId}/{engineId}/search/pushstat/querylog, and click tracking uses POST /api/v3/{customerId}/{engineId}/search/pushstat/clicklog.Send both query and click events so analytics can connect searches to clicked results. See the legacy API documentation for the full v3 tracking reference.
Use the sort parameter to order results by a field, including custom crawler fields that are configured for sorting. Sorting is commonly used for dates, titles, numeric fields, and custom metadata such as product price or content type.
Search only returns content that has been indexed. A page can exist on your website but be absent from the index if the crawler is blocked, the page is excluded by crawler rules, the content is rendered in a way the crawler cannot pick up, or the page has not been crawled since it changed. See Troubleshooting → Content Indexing Issues.
Facet counts are calculated server-side across all matching documents, not just the current page. They reflect how many documents in the full result set match each facet value — independent of page and perPage.To use facets, the relevant fields must be enabled for faceting. Contact support@cludo.com with your engine ID and field names, then include enableFacetFiltering: true in your search request.

​
AI Chat & AI Summary

  • AI Chat generates a conversational answer to a question, grounded in your search index. Supports multi-turn conversations.
  • AI Summary summarizes a set of search result documents. You provide the search results, and it returns a synthesized summary.
Both support streaming and non-streaming modes.
AI Chat requires the AiChat feature flag to be enabled on your engine. Contact support@cludo.com or check your engine settings in MyCludo.
This boolean field in the search response indicates whether AI has enough signal to attempt an answer for the query. If true, you can call the AI Chat endpoint for an answer grounded in your indexed content.Treat true as a hint, not a guarantee — the AI streaming endpoint may still return an error (such as a 502) if the model is temporarily unavailable. Always implement a fallback that hides the AI panel gracefully rather than surfacing a raw error to the user.If the value is false, the query may be too broad, the matching indexed content may not contain enough answerable text, or the relevant website content may not be indexed because of crawler configuration or crawlability issues.
AI Summary is generated from the documents you provide in the request. To influence the result, choose the search results or documents you pass to the summary endpoint carefully and make sure each document includes useful title, URL, and text fields.See the AI Summary API reference.

​
Content Management

Use v4 Index Management for document replacement, partial updates, and deletion. It supports partial updates (PATCH), advanced bulk-delete filters, and uses your crawler id in paths such as /index/{crawlerId}/documents. See Index Management.If your v3 integration uses PushURLs to queue pages for crawling, use POST /api/v4/{customerId}/crawler/{crawlerId}/paths in v4.See API Versions: v3 vs v4 for version guidance. For the full v3 API reference, see the legacy documentation.
Check these common issues:
  1. Wrong crawler id: v4 document APIs use /index/{crawlerId}/documents — use the crawler id from MyCludo (same id as in v3 /content/{crawlerId} flows).
  2. Missing useful fields: Ensure each document has an id and meaningful fields such as Title, Url, and Description
  3. Give it time: Documents may take a few seconds to become searchable
  4. Check your region: EU credentials don’t work against the US endpoint
  5. Validate crawled URLs: For website content, use the crawler URL test in MyCludo to verify that the crawler can fetch and index the page.
See Troubleshooting → Content Indexing.
You still need a crawler entity in MyCludo, but it does not need to actively crawl anything. The crawlerId in Content API paths (/index/{crawlerId}/documents) is an index container identifier, not a requirement to run crawls.Create a crawler in MyCludo, then disable scheduled crawling so it never runs automatically. If you leave scheduled crawling on, the crawler may overwrite or remove documents you pushed via the API.

​
Analytics

  • Total searches counts every search event received, including repeated searches from the same user in the same session.
  • Unique searches counts only the first search for a given query within a session.
If your popular searches all show the same low count, it usually means each search is being tracked as a separate unique event — often caused by missing or inconsistent session identifiers in the tracking payload.
  1. Analytics events: If you built a custom search UI, you must send tracking events manually or install the Cludo analytics script. Events are not sent automatically.
  2. Both event types: Send both query events (querylog) and click events (clicklog). Missing one means analytics will be incomplete.

​
Still have questions?

Email support@cludo.com with your customer ID, engine ID, and a description of your issue.