Get a task

GET /tasks/:taskUid

Api key

Get a task

Path parameters

taskUid integer Required

The task identifier

Responses

• 200 application/json

OK
Hide response attributes Show response attributes object
- uid integer Required
  
  The unique sequential identifier of the task
- indexUid string Required
  
  The unique identifier of the index where this task is operated
- status string Required
  
  The status of the task
  
  Values are enqueued, processing, succeeded, or failed.
- type string Required
  
  The type of the task
  
  Values are documentAdditionOrUpdate, documentDeletion, indexCreation, indexUpdate, indexDeletion, indexSwap, settingsUpdate, dumpCreation, taskCancelation, taskDeletion, or snapshotCreation.
- canceledBy integer Required
  
  The uid of the task that performed the taskCancelation if the task has been canceled.
- details object Required
  
  Details information of the task payload.
  
  Hide details attributes Show details attributes
  
  receivedDocuments integer
  
  Number of documents received for documentAdditionOrUpdate task.
  
  indexedDocuments integer
  
  Number of documents finally indexed for documentAdditionOrUpdate task or a documentAdditionOrUpdate batch of tasks.
  
  providedIds integer
  
  Number of provided document ids for the documentDeletion task.
  
  deletedDocuments integer
  
  Number of documents finally deleted for documentDeletion and indexDeletion tasks.
  
  primaryKey string
  
  Value for the primaryKey field encountered if any for indexCreation or indexUpdate task.
  
  settings object
  
  Learn more about the settings in this guide.
  
  Hide settings attributes Show settings attributes
  
  synonyms object Required
  
  List of associated words treated similarly. A word associated to an array of word as synonyms.
  
  stopWords array[string] Required
  
  List of words ignored when present in search queries.
  
  rankingRules array[string] Required
  
  List of ranking rules sorted by order of importance. The order is customizable.
  
  A list of ordered built-in ranking rules.
  
  filterableAttributes array[string] Required
  
  Attributes to use for faceting and filtering. See Filtering and Faceted Search.
  
  distinctAttribute string | null Required
  
  Search returns documents with distinct (different) values of the given field.
  
  searchableAttributes array[string] Required
  
  Fields in which to search for matching query words sorted by order of importance.
  
  displayedAttributes array[string] Required
  
  Fields displayed in the returned documents.
  
  typoTolerance object Required
  
  Customize typo tolerance feature.
  
  Hide typoTolerance attributes Show typoTolerance attributes
  
  enabled boolean
  
  Enable the typo tolerance feature.
  
  Default value is true.
  
  disableOnAttributes array[string]
  
  Disable the typo tolerance feature on the specified attributes.
  
  Default value is [] (empty).
  
  disableOnWords array[string]
  
  Disable the typo tolerance feature for a set of query terms given for a search query.
  
  Default value is [] (empty).
  
  minWordSizeForTypos object
  
  Hide minWordSizeForTypos attributes Show minWordSizeForTypos attributes
  
  oneTypo integer
  
  Customize the minimum size for a word to tolerate 1 typo.
  
  Default value is 5.
  
  twoTypos integer
  
  Customize the minimum size for a word to tolerate 2 typos.
  
  Default value is 9.
  
  Additional properties are NOT allowed
  
  dumpUid string
  
  Identifier generated for the dump for dumpCreation task.
  
  matchedTasks integer
  
  Number of tasks that match the request for taskCancelation or taskDeletion tasks.
  
  canceledTasks integer
  
  Number of tasks canceled for taskCancelation.
  
  deletedTasks integer
  
  Number of tasks deleted for taskDeletion.
  
  originalFilter string
  
  Original filter query for taskCancelation or taskDeletion tasks.
- error object Required
  
  Error object containing error details and context when a task has a failed status.
  
  Hide error attributes Show error attributes
  
  message string Required
  
  code string Required
  
  type string Required
  
  link string Required
- duration string | null
  
  Total elasped time the engine was in processing state expressed as a ISO-8601 duration format. Default is set to null
- enqueuedAt string Required
  
  An RFC 3339 format for date/time/duration.
- startedAt string Required
  
  An RFC 3339 format for date/time/duration.
- finishedAt string Required
  
  An RFC 3339 format for date/time/duration.
- Additional properties are NOT allowed
• 401 application/json

Unauthorized
Hide response attributes Show response attributes object
- message string Required
- code string Required
- type string Required
- link string Required
• 404 application/json

Not Found
Hide response attributes Show response attributes object
- message string Required
- code string Required
- type string Required
- link string Required

GET /tasks/:taskUid

curl \
 -X GET https://example.meilisearch.com:7700/tasks/:taskUid \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "uid": 1,
  "indexUid": "movies",
  "status": "succeeded",
  "type": "documentAdditionOrUpdate",
  "canceledBy": null,
  "details": {
    "receivedDocuments": 79000,
    "indexedDocuments": 79000
  },
  "error": null,
  "duration": "PT1S",
  "enqueuedAt": "2021-01-01T09:39:00.000000Z",
  "startedAt": "2021-01-01T09:39:01.000000Z",
  "finishedAt": "2021-01-01T09:39:02.000000Z"
}

Response examples (401)

{
  "message": "The Authorization header is missing. It must use the bearer authorization method.",
  "code": "missing_authorization_header",
  "type": "auth",
  "link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}

Response examples (404)

{
  "message": "Task :taskUid not found.",
  "code": "task_not_found",
  "type": "invalid_request",
  "link": "https://docs.meilisearch.com/errors/#task_not_found"
}