View API Reference



API Method Description PHP Ruby JS Python iOS Android C# Java Go Scala name
Add objects

Add new objects (records) to an index.

addObjects addObjects add_objects add_objects AddObjects addObjects addObjects addObjectsAsync AddObjects addObjects index into
Update objects

Replace an existing object with an updated set of attributes.

saveObjects saveObjects save_objects save_objects SaveObjects saveObjects saveObjects saveObjectsAsync UpdateObjects saveObjects index into
Partial update objects

Update one or more attributes of an existing object.

partialUpdateObjects partialUpdateObjects partial_update_objects partial_update_objects PartialUpdateObjects partialUpdateObjects PartialUpdateObjects partialUpdateObjectsAsync PartialUpdateObjects partialUpdateObjects partialUpdate
Delete objects

Remove objects from an index using their object ids.

deleteObjects deleteObjects delete_objects delete_objects DeleteObjects deleteObjects deleteObjects deleteObjectsAsync DeleteObjects deleteObjects delete from
Delete by query

Remove all objects matching a query.

deleteByQuery deleteByQuery delete_by_query delete_by_query deleteByQuery deleteByQuery deleteByQuery deleteByQueryAsync DeleteByQuery deleteByQuery deleteByQuery
Get objects

Get one or more objects using their object ids.

getObjects getObjects get_objects get_objects getObjects getObjects getObjects getObjectsAsync GetObjects getObjects get from "index"
Wait for operations

Wait for a task to complete before executing the next line of code, to synchronize index updates.

waitTask waitTask wait_task wait_task WaitTask waitTask waitTask waitTaskAsync WaitTask waitTask waitFor task

Creating indexes

You don’t need to explicitly create an index, it will be automatically created the first time you add an object. Objects are schema less so you don’t need any configuration to start indexing. If you wish to configure things, the settings section provides details about advanced settings.


Object / Record

We use these 2 words interchangeably. Sometimes witin the same sentence. So don’t place any significance on their usage:

  • Indexes contain objects or records
  • JSON contains objects or records


All objects and records contain attributes … or fields, or elements. Within the search and indexing contexts, we often speak of settings and parameters. Again, these terms are mostly interchangeable.

Some attributes are simple key/value pairs. But others can be more complex, making it look more like a collection or an object.