Describe an AI Index

Base URL: https://{kibana_url}

GET /api/context_engine/ai_index/{aiIndexId}/_describe
GET /s/{space_id}/api/context_engine/ai_index/{aiIndexId}/_describe

Auth

Returns a free-form text context block for an agent. The block describes the AI Index and its ES|QL target. It also includes up to 500 fields exposed by the backing indices, identifies which fields are semantic, provides knowledge item type and tag counts for the current space, and includes example ES|QL queries.

The API reads data as the current user. Elasticsearch index privileges limit which indices the current user can access. A caller who cannot read the backing indices gets a 403 response.

The space comes from the request URL (/s/{spaceId}/…) or defaults to the default space. It cannot be specified in any other way.

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

For more information, refer to the Context Engine documentation.

Required authorization

Privileges contextEngine:read

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
aiIndexId string · min length: 1 · max length: 256 required: The unique identifier of the AI Index.

Responses

A free-form text context block describing the AI Index.

application/json

response string required: Free-form text context block describing the AI Index for an agent.

The description response exceeded the size limit.

application/json

error string: The HTTP status text.
message string required: A human-readable error message.
statusCode number: The HTTP status code.

The caller cannot read the backing indices. Describing an AI Index requires the read and view_index_metadata index privileges on them.

application/json

error string: The HTTP status text.
message string required: A human-readable error message.
statusCode number: The HTTP status code.

No AI Index with the given ID exists in the current space, or Context Engine is turned off in this space.

application/json

error string: The HTTP status text.
message string required: A human-readable error message.
statusCode number: The HTTP status code.