Skip to main content
GET
/
indexes
/
{indexUid}
/
settings
/
chat
cURL
curl \
  -X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat'
{}

Authorizations

​
Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

const client = new MeiliSearch({
  host: 'MEILISEARCH_URL',
  apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});

Path Parameters

​
indexUid
string
required

Unique identifier of the index.

Response

Returns the current value of the chat setting.

Configuration settings for AI-powered chat and search functionality.

These settings control how documents are presented to the LLM and what search parameters are used when the LLM queries the index.

​
description
string | null

A description of this index that helps the LLM understand its contents and purpose. This description is provided to the LLM to help it decide when and how to query this index. Example: "Contains product catalog with prices and descriptions".

​
documentTemplate
string | null

A liquid template used to render documents to a text that can be embedded.

Meillisearch interpolates the template for each document and sends the resulting text to the embedder. The embedder then generates document vectors based on this text.

​
documentTemplateMaxBytes
integer | null

Maximum size in bytes for the rendered document text. Texts longer than this limit are truncated. This prevents very large documents from consuming too much context in the LLM conversation. Defaults to 400 bytes.

Required range: x >= 0
​
searchParameters
object

Default search parameters used when the LLM queries this index. These settings control how search results are retrieved and ranked. If not specified, standard search defaults are used.