PIpipeshub-ai
Knowledge Base

Reindex single record

Changed on

Trigger reindexing for a specific record.

Overview:

Reprocesses the record's content to update search indexes and AI embeddings. Useful after content changes or to fix indexing failures.

Depth parameter:

Controls processing depth for complex documents (-1 for full depth, 0–100 for limited).

Status filters:

Optional statusFilters array limits reindex to records in matching indexing states (e.g. FAILED, AUTO_INDEX_OFF, PASSWORD_PROTECTED). Any string is accepted.

Access: any role on the record's knowledge base may reindex it, READER included. For a connector record, read access to the record is enough. A record of a disabled connector is refused with 409, a record in the trash with 400.

Request: only depth and statusFilters are read; other body fields (force included) and any query parameter are ignored. The body is optional.

post/knowledgeBase/reindex/record/{recordId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/reindex/record/{recordId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:write

Path parameters

recordIdstring required

Request body

depthinteger

Child traversal depth (0 = record only; higher values include descendants; -1 = all of them; 100 is used by clients for folder-like reindex).

statusFiltersIndexingStatusFilter[]

When set, only records whose indexing status matches one of these values are reindexed (applies to the record and its descendants per depth).

Response

Reindexing triggered successfully

successtrue required
messagestring required
recordIdstring nullable
recordNamestring nullable
connectorstring nullable
eventPublishedboolean required
userRolestring nullable
depthinteger required

Changes

  • dbb5e203b445Revision changes
    • breaking

      removed the enum value AUTO_INDEX_OFF of the request property /

    • breaking

      removed the enum value COMPLETED of the request property /

    • breaking

      removed the enum value EMPTY of the request property /

    • breaking

      removed the enum value FAILED of the request property /

    • breaking

      removed the enum value FILE_TYPE_NOT_SUPPORTED of the request property /

    • breaking

      removed the enum value IN_PROGRESS of the request property /

    • breaking

      removed the enum value NOT_STARTED of the request property /

    • breaking

      removed the enum value QUEUED of the request property /

    • breaking

      removed the enum value SKIPPED of the request property /

    • warning

      removed the request property

  • fc76aa045994Revision changes
    • info

      added the new SKIPPED enum value to the request property /