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.

Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
require "algolia"

client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.batch(
  "ALGOLIA_INDEX_NAME",
  Algolia::Search::BatchWriteParams.new(
    requests: [
      Algolia::Search::BatchRequest.new(action: "addObject", body: {key: "bar", foo: "1"}),
      Algolia::Search::BatchRequest.new(action: "addObject", body: {key: "baz", foo: "2"})
    ]
  )
)
Did you find this page helpful?
Ruby API clients v3