Cludo API versions: v3 and v4

13 May, 2026 FAQ, Implementation

Cludo offers two API versions: v3 (legacy) and v4 (current). New integrations should use v4 where possible.

v4 API

RESTful design with consistent paths and request/response shapes.

  • Search: POST /api/v4/{customerId}/{engineId}/search
  • Autocomplete: GET /api/v4/{customerId}/{engineId}/autocomplete
  • AI Chat: POST /api/v4/{customerId}/{engineId}/search/answer
  • AI Summary: POST /api/v4/{customerId}/{engineId}/search/summarize
  • Index Management (push/update/delete documents): PUT|PATCH|DELETE /api/v4/{customerId}/index/{crawlerId}/documents
  • Authentication: SiteKey (client-side) or Basic / API Key (server-side). Same credentials as v3; only the base path and payload format differ.
  • Base URLs: https://api.cludo.com (EU) or https://api-us1.cludo.com (US). Use the URL that matches your Customer ID range.

v3 API (legacy)

Still supported for existing integrations. Many endpoints use query parameters or older response formats.

  • Search and other endpoints live under /api/v3/.
  • Analytics tracking endpoints remain on v3 and have no v4 equivalent: POST /api/v3/{customerId}/{engineId}/search/pushstat/querylog and /clicklog.
  • If you are building something new, prefer v4 for consistency and future support.

Search Tools (unversioned)

Banners, Page Rankings, Quicklinks, and Synonyms use unversioned paths (/api/banners/, /api/rankings/, etc.). Do not add /v3 or /v4 to these endpoints.

Migration

If you are on v3 and want to move to v4, your Customer ID, Engine ID, and auth credentials (SiteKey or API Key) stay the same — you only change the base path and request/response format. See the API versions guide for a feature-by-feature breakdown. For v3 endpoint reference, see the legacy API documentation.

Related Posts