You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**`primaryKey`**|`null`|[Primary key](/learn/getting_started/primary_key#primary-field) of the index |
258
258
|**`csvDelimiter`**|`","`| Configure the character separating CSV fields. Must be a string containing [one ASCII character](https://www.rfc-editor.org/rfc/rfc20). |
259
+
|**`customMetadata`**|`null`| An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata)|
259
260
260
261
<Warning>
261
262
Configuring `csvDelimiter` and sending data with a content type other than CSV will cause Meilisearch to throw an error.
@@ -378,6 +379,7 @@ This endpoint accepts the following content types:
|**`primaryKey`**|`null`|[Primary key](/learn/getting_started/primary_key#primary-field) of the documents |
380
381
|**`csvDelimiter`**|`","`| Configure the character separating CSV fields. Must be a string containing [one ASCII character](https://www.rfc-editor.org/rfc/rfc20). |
382
+
|**`customMetadata`**|`null`| An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata)|
381
383
382
384
<Warning>
383
385
Configuring `csvDelimiter` and sending data with a content type other than CSV will cause Meilisearch to throw an error.
@@ -451,6 +453,7 @@ curl \
451
453
|**`function`**|`null`| A string containing a RHAI function |
452
454
|**`filter`**|`null`| A string containing a filter expression |
453
455
|**`context`**|`null`| An object with data Meilisearch should make available for the editing function |
456
+
|**`customMetadata`**|`null`| An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata)|
454
457
455
458
#### `function`
456
459
@@ -487,6 +490,12 @@ Delete all documents in the specified index.
Copy file name to clipboardExpand all lines: reference/api/tasks.mdx
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,8 @@ The `/tasks` route gives information about the progress of [asynchronous operati
35
35
"duration": "PT0.001192S",
36
36
"enqueuedAt": "2022-08-04T12:28:15.159167Z",
37
37
"startedAt": "2022-08-04T12:28:15.161996Z",
38
-
"finishedAt": "2022-08-04T12:28:15.163188Z"
38
+
"finishedAt": "2022-08-04T12:28:15.163188Z",
39
+
"customMetadata": null
39
40
}
40
41
```
41
42
@@ -250,6 +251,11 @@ curl \
250
251
**Type**: String<br />
251
252
**Description**: The date and time when the task finished `processing`, whether `failed`, `succeeded`, or `canceled`, in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format
252
253
254
+
### `customMetadata`
255
+
256
+
**Type**: String<br />
257
+
**Description**: An arbitrary string optionally configured for `/document`-related tasks. Commonly used to keep track of which documents were processed in a specific task.
258
+
253
259
### Summarized task object
254
260
255
261
When an API request triggers an asynchronous process, Meilisearch returns a summarized task object. This object contains the following fields:
0 commit comments