Skip to main content

Index documents

POST 
/content-assistance/index

Crawls and indexes one or more documents into the specified knowledge base index type. The documents are fetched from their URLs, chunked, and stored for use in retrieval-augmented generation.

  • For GENERAL type: only urls is required.
  • For CATEGORY / CATEGORY_SHARED type: provide urls plus either scopeIds (category concept IDs) or breadcrumbs.
  • For PRODUCT type: provide urls plus either scopeIds (product IDs) or identifiers.
  • For CONDITIONAL / CONDITIONAL_SHARED type: provide urls plus scopeIds (the IDs of the Conditional Documents the URLs should be attached to, as listed under AI Knowledge Base in Data Platform).

The _SHARED variants index documents across all locales (the project group); the non-shared CATEGORY and CONDITIONAL variants apply to the current locale only. GENERAL and PRODUCT are always locale-specific.

This operation is asynchronous and returns a task that can be monitored via the Tasks endpoint.

Request​

Responses​

OK — indexing task started