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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { algoliasearch } from 'algoliasearch';

//
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

const response = await client.saveObject({
  indexName: 'ALGOLIA_INDEX_NAME',
  body: {
    name: 'Black T-shirt',
    color: '#000000||black',
    availableIn: 'https://source.unsplash.com/100x100/?paris||Paris',
    objectID: 'myID',
  },
});