Edit documents by function

Use a RHAI function to edit one or more documents directly in Meilisearch. The function receives each document and returns the modified document.

POST /indexes/{indexUid}/documents/edit

cURL

cURL

curl \
  -X POST 'MEILISEARCH_URL/indexes/movies/documents/edit' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "function": "doc.new_field = `a]new[value`",
    "filter": "id > 3000",
    "context": {
      "max_title_length": 10
    }
  }'

202

{
  "taskUid": 147,
  "indexUid": null,
  "status": "enqueued",
  "type": "documentDeletion",
  "enqueuedAt": "2024-08-08T17:05:55.791772Z"
}

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.

Body

application/json

Request body for editing documents using a JavaScript function

function · string · required

RHAI function to apply to each document

filter · any

Filter expression to select which documents to edit

context · any

Data to make available for the editing function

Response

202

application/json

Task successfully enqueued.

A summarized view of a task, returned when a task is enqueued

taskUid · integer<u-int32> · required

Unique sequential identifier of the task.

Required range: x >= 0

status · enum<string> · required

Status of the task. Possible values are enqueued, processing, succeeded, failed, and canceled.

Available options: enqueued, processing, succeeded, failed, canceled

Example:

"processing"

type · enum<string> · required

Type of operation performed by the task.

Available options: documentAdditionOrUpdate, documentEdition, documentDeletion, settingsUpdate, indexCreation, indexDeletion, indexUpdate, indexSwap, taskCancelation, taskDeletion, dumpCreation, snapshotCreation, export, upgradeDatabase, indexCompaction, networkTopologyChange

Example:

"documentAdditionOrUpdate"

enqueuedAt · string<date-time> · required

Date and time when the task was enqueued.

indexUid · string | null

Unique identifier of the targeted index. Null for global tasks.

customMetadata · string | null

Custom metadata attached to this task at creation. Use it to associate tasks with external systems or add application-specific information.