Add a new record (with auto-generated object ID)

Adds a record to an index or replaces it.

  • If the record doesn’t have an object ID, a new record with an auto-generated object ID is added to your index.
  • If a record with the specified object ID exists, the existing record is replaced.
  • If a record with the specified object ID doesn’t exist, a new record is added to your index.
  • If you add a record to an index that doesn’t exist yet, a new index is created.

To update some attributes of a record, use the partial operation. To add, update, or replace multiple records, use the batch operation.

This operation is subject to indexing rate limits.

Usage

Required ACL: addObject
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import algoliasearch.api.SearchClient
import algoliasearch.config.*
import algoliasearch.extension.SearchClientExtensions

val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

val response = Await.result(
  client.saveObject(
    indexName = "ALGOLIA_INDEX_NAME",
    body = JObject(
      List(
        JField("name", JString("Black T-shirt")),
        JField("color", JString("#000000||black")),
        JField("availableIn", JString("https://source.unsplash.com/100x100/?paris||Paris")),
        JField("objectID", JString("myID"))
      )
    )
  ),
  Duration(100, "sec")
)
Did you find this page helpful?
Scala API clients v2