Algolia Batch

POST

https://acme.captain.dev/1/indexes/:index/batch

POST

/1/indexes/:index/batch

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_write_key"
INDEX = "products"
headers = {
    "x-algolia-api-key": API_KEY,
    "x-algolia-application-id": "acme",
    "Content-Type": "application/json",
}
response = requests.post(
    f"{BASE_URL}/1/indexes/{INDEX}/batch",
    headers=headers,
    json={
        "requests": [
            {
                "action": "addObject",
                "body": {
                    "objectID": "sku-10482",
                    "title": "Moab 3 Mid Waterproof Hiking Boot",
                    "price": 139.0,
                },
            },
            {"action": "deleteObject", "body": {"objectID": "sku-10517"}},
        ],
    },
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Successful

{
  "taskID": 1854,
  "objectIDs": [
    "sku-10482",
    "sku-10517"
  ]
}

Algolia’s batch writes with a Captain write key: addObject, updateObject, partialUpdateObject(NoCreate), deleteObject, clear and delete. taskID is the write’s seq.

Authentication

x-algolia-api-keystring

A Captain key, as Algolia clients send it: a search key for queries, a write key for writes.

x-algolia-application-idstring

Any value; the hostname selects the tenant.

Path parameters

indexstringRequired

Request

This endpoint expects an object.

requestslist of objectsRequired

Response

accepted

taskIDinteger or map from strings to anyOptional

the write’s seq (an object of index -> seq for the multi-index batch, /1/indexes/*/batch)

objectIDslist of stringsOptional