Skip to main content
Retrieves items from the index by ID, with the fields you choose.

Parameters

Returns

Promise<GetResultItem[]>, one object per ID found. IDs that don’t exist are left out of the result without an error, and an empty ids array returns []. When include doesn’t contain 'vector', an existing item that has none of the requested fields is also left out.
contents is always a string. Contents upserted as bytes come back as their base64 text; decode them with Buffer.from(contents, 'base64') on Node, or atob() elsewhere.

Exceptions

The indexKey or apiKey is invalid (HTTP 401).
The service returns 5xx.
See Errors for the full hierarchy.

Example Usage

Decode bytes contents