Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

Path Parameters

index_uid
string
required

Unique identifier of the index.

Query Parameters

offset
integer

Number of documents to skip in the response. Use this parameter together with limit to paginate through large document sets. For example, to get documents 21-40, set offset=20 and limit=20. Defaults to 0.

Required range: x >= 0
limit
integer

Maximum number of documents to return in a single response. Use together with offset for pagination. Defaults to 20.

Required range: x >= 0
fields
string[]

Comma-separated list of document attributes to include in the response. Use * to retrieve all attributes. By default, all attributes are returned. Example: title,description,price.

retrieveVectors
boolean

When true, includes vector embeddings in the response for documents that have them. This is useful when you need to inspect or export vector data. Defaults to false.

ids
string[]

Comma-separated list of document IDs to retrieve. Only documents with matching IDs will be returned. If not specified, all documents matching other criteria are returned.

filter
string

Filter expression to select which documents to return. Attributes must be added to the filterableAttributes index setting before they can be used in filters. Only accepts string expressions (not array syntax). Example: genres = action AND rating > 4.

sort
string

Attribute(s) to sort the documents by. Format: attribute:asc or attribute:desc. Multiple sort criteria can be comma-separated. Example: price:asc,rating:desc.

Response

The documents are returned.

results
any[]
required

Items for the current page.

offset
integer
required

Number of items skipped.

Required range: x >= 0
limit
integer
required

Maximum number of items returned.

Required range: x >= 0
total
integer
required

Total number of items matching the query.

Required range: x >= 0