context engine

Delete an AI Index

Spaces method and path for this operation:

<div><span class="operation-verb delete">delete</span>&nbsp;<span class="operation-path">/s/{space_id}/api/context_engine/ai_index/{aiIndexId}</span></div>

Refer to Spaces for more information.

Deletes an AI Index by ID.

By default, the API preserves the backing data stream or index, its Knowledge Indicators, and attached workflow automations. Set delete_knowledge_indicators to true to delete the backing data stream or index and its Knowledge Indicators. Set delete_automations to true to delete the attached workflow automations.

The API does not delete the backing data stream or index when another AI Index uses the same destination.

Returns a 404 response when Context Engine is turned off in this space (contextEngine:enabled).

For more information, refer to the Context Engine documentation.<br/><br/>[Required authorization] Route required privileges: contextEngine:write. Extended privileges (optional, expand functionality when granted): workflowsManagement:delete.

delete/api/context_engine/ai_index/{aiIndexId}

Path parameters

aiIndexIdstring required

The unique identifier of the AI Index.

Query parameters

delete_knowledge_indicatorsboolean

When true, also delete the backing data stream/index, which removes its Knowledge Indicators. Skipped when another AI Index still uses the same dest. Defaults to false.

delete_automationsboolean

When true, also delete the attached workflow automations. Defaults to false.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Response

The AI Index entry was deleted. errors lists any best-effort cleanup failures.

acknowledgedboolean required

Whether the AI Index entry was deleted.

errorsstring[] required

Best-effort cleanup errors after the entry was deleted, if any.

Changes

No changes recorded. 38 of the 194 revisions have no diff computed, so they could not be searched.