Batch indexing operations on one index

Adds, updates, or deletes records in one index with a single API request.

Batching index updates reduces latency and increases data integrity.

• Actions are applied in the order they’re specified.
• Actions are equivalent to the individual API requests of the same name.

This operation is subject to indexing rate limits.

POST /1/indexes/{indexName}/batch

curl

cURL

curl --request POST \
  --url https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/batch \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"requests":[{"action":"addObject","body":{"name":"Betty Jane McCamey","company":"Vita Foods Inc.","email":"[e-mail]"}},{"action":"addObject","body":{"name":"Gayla geimer","company":"Ortman McCain Co.","email":"[e-mail]"}}]}'

200

{
  "taskID": 1514562690001,
  "objectIDs": [
    "record-1",
    "record-2"
  ]
}

Required ACL: addObject

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName · string · required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

Body

application/json

Batch parameters.

requests · batchRequest · object[] · required

Show child attributes

requests. action · enum<string> · required

Which indexing operation to perform:

• addObject: adds records to an index. Equivalent to the "Add a new record (with auto-generated object ID)" operation.
• updateObject: adds or replaces records in an index. Equivalent to the "Add or replace a record" operation.
• partialUpdateObject: adds or updates attributes within records. Equivalent to the "Add or update attributes" operation with the createIfNoExists parameter set to true. (If a record with the specified objectID doesn't exist in the specified index, this action creates adds the record to the index)
• partialUpdateObjectNoCreate: same as partialUpdateObject, but with createIfNoExists set to false. (A record isn't added to the index if its objectID doesn't exist)
• deleteObject: delete records from an index. Equivalent to the "Delete a record" operation.
• delete. Delete an index. Equivalent to the "Delete an index" operation.
• clear: delete all records from an index. Equivalent to the "Delete all records from an index operation".

Available options: addObject, updateObject, partialUpdateObject, partialUpdateObjectNoCreate, deleteObject, delete, clear

requests. body · object · required

Operation arguments (varies with specified action).

Example:

{
  "name": "Betty Jane McCamey",
  "company": "Vita Foods Inc.",
  "email": "[e-mail]"
}

Response

200

application/json

OK

taskID · integer<int64> · required

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this task ID.

Example:

1514562690001

objectIDs · string[] · required

Unique record identifiers.

Example:

["record-1", "record-2"]