Document and Fields

How indexed content is structured for search.

A document is a single indexed item — typically a page, article, or product. Each document has a stable id (often the canonical URL) and a fields object containing the searchable and displayable values.

Create or update documents through Index Management; the request body is a plain JSON array of { id, fields } objects. The same field names appear back on the Search response under TypedDocuments[].Fields.

Fields are keyed by name and are case-sensitive. Common fields include Title, Url, Description, Date, Category, Language, and Content. When you push content through Index Management, the field shape is defined by the payload itself — you can include any custom fields directly in the fields object and they will be searchable and displayable in the Search response.

Using a field as a facet or filter requires a one-time backend setup on Cludo’s side. Email Cludo support with the engine ID and the field names you want enabled for faceting or filtering.

If you are pushing content through the API, we recommend disabling scheduled crawling on the crawler in MyCludo so the index only contains your pushed content. For crawler-fetched content, custom fields are configured per-crawler in MyCludo instead.