Create or Replace

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.

PUT /api/v4/{customerId}/index/{crawlerId}/documents

Create or Replace

cURL

curl --request PUT \
  --url https://api.cludo.com/api/v4/{customerId}/index/{crawlerId}/documents \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": "<string>",
    "fields": {},
    "type": "PageContent"
  }
]
'

200

[
  {
    "document": {
      "id": "<string>",
      "type": 123,
      "fields": {}
    },
    "reason": "<string>",
    "success": true
  }
]

Authorizations

Authorization · string · header · required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Path Parameters

customerId · integer · required

Your Cludo Customer ID (same as in MyCludo and Basic auth username).

crawlerId · integer · required

Crawler (content source) ID from MyCludo.

Body

application/json

id · string · required

Stable unique key for upserts and deletes—most integrations use the canonical page URL.

fields · object · required

Keyed by engine field names (case-sensitive). Typical keys: Title, Url, Description, Category, Date, Language, Content. Only string values in this API shape.

Show child attributes

type · enum<string> · default: PageContent

Optional document kind. Sibling of id and fields (not inside fields). Defaults to "PageContent"; use "FileContent" for files such as PDFs or DOCX so they are treated as file results in the index.

Available options: PageContent, FileContent

Response

200

application/json

Documents replaced successfully.

document · object

Show child attributes

reason · string

Success message (e.g. “Index succeed”) or failure detail.

success · boolean

Per-row outcome; check when batching many documents.