> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cludo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi/index-management.json put /api/v4/{customerId}/index/{crawlerId}/documents
openapi: 3.1.0
info:
  title: Cludo Index Management API
  version: 4.0.0
  description: Index documents, bulk operations, and queue URLs for crawling.
servers:
  - url: https://api.cludo.com
    description: EU region (Customer IDs below 10,000,000)
  - url: https://api-us1.cludo.com
    description: US region (Customer IDs 10,000,000 and above)
security:
  - BasicAuth: []
paths:
  /api/v4/{customerId}/index/{crawlerId}/documents:
    put:
      summary: Create or Replace
      description: >-
        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.
      operationId: createOrReplaceDocuments
      parameters:
        - $ref: '#/components/parameters/customerId'
        - $ref: '#/components/parameters/crawlerId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Document'
      responses:
        '200':
          description: Documents replaced successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentOperationResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BasicAuth: []
components:
  parameters:
    customerId:
      name: customerId
      in: path
      required: true
      description: Your Cludo Customer ID (same as in MyCludo and Basic auth username).
      schema:
        type: integer
    crawlerId:
      name: crawlerId
      in: path
      required: true
      description: 'Crawler (content source) ID from MyCludo. '
      schema:
        type: integer
  schemas:
    Document:
      type: object
      required:
        - id
        - fields
      properties:
        id:
          type: string
          description: >-
            Stable unique key for upserts and deletes—most integrations use the
            canonical page URL.
        type:
          type: string
          enum:
            - PageContent
            - FileContent
          default: PageContent
          description: >-
            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.
        fields:
          type: object
          additionalProperties:
            type: string
          description: >-
            Keyed by **engine field names** (case-sensitive). Typical keys:
            `Title`, `Url`, `Description`, `Category`, `Date`, `Language`,
            `Content`. Only string values in this API shape.
    DocumentOperationResult:
      type: object
      properties:
        document:
          $ref: '#/components/schemas/IndexedDocument'
        reason:
          type: string
          description: Success message (e.g. “Index succeed”) or failure detail.
        success:
          type: boolean
          description: Per-row outcome; check when batching many documents.
    IndexedDocument:
      type: object
      properties:
        id:
          type: string
          description: Echo of the document id after indexing.
        type:
          type: integer
          description: >-
            Document kind: 0 = PageContent, 1 = FileContent. Echoes the value
            sent on push (defaulting to 0).
        fields:
          type: object
          additionalProperties:
            type: string
          description: Fields stored for this document after the operation.
    ErrorResponse:
      type: object
      description: Error response returned when a request fails.
      properties:
        message:
          type: string
          description: A message describing what went wrong.
    UnauthorizedError:
      type: object
      description: Returned when authentication fails.
      properties:
        message:
          type: string
          description: Authentication failure reason.
    ServerError:
      type: object
      description: Returned when an unexpected server error occurs.
      properties:
        status:
          type: string
          description: HTTP status name.
        code:
          type: integer
          description: HTTP status code.
        messages:
          type: array
          items:
            type: string
          description: Error details, usually including a support reference id.
  responses:
    BadRequest:
      description: >-
        The request is invalid. This typically occurs due to missing required
        fields, incorrect parameter values, or malformed request body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            message: >-
              The request could not be processed. Check the request body and
              required parameters.
    Unauthorized:
      description: >-
        Authentication failed. The Authorization header is missing or contains
        invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
          example:
            message: unauthorized
    InternalServerError:
      description: >-
        An unexpected server error occurred. If this persists, contact
        support@cludo.com.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerError'
          example:
            status: InternalServerError
            code: 500
            messages:
              - >-
                Error occur. Please contact support with error ID:
                a1b2c3d4-e5f6-7890-abcd-ef1234567890
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication. Use your Customer ID as the username and API Key
        as the password. Example header: `Authorization: Basic
        MTIzNDU2NzpteS1hcGkta2V5`.

````