Get document
Retrieve a single document by its primary key value.
Authorizations
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
Unique identifier of the index.
The document identifier.
Query Parameters
Comma-separated list of document attributes to include in the
response. Use * to retrieve all attributes. By default, all
attributes listed in the displayedAttributes setting are returned.
Example: title,description,price.
When true, includes the vector embeddings in the response for this
document. This is useful when you need to inspect or export vector
data. Note that this can significantly increase response size if the
document has multiple embedders configured. Defaults to false.
When true, runs the query on the whole network (all shards covered exactly once).
When false, the query runs locally.
When omitted or null, the default value depends on whether the sharding is enabled for the instance:
- If the instance has sharding enabled (has a leader), defaults to
true. - Otherwise defaults to
false.
It also requires the network experimental feature.
Values: true = use the whole network; false = local, default = see above.
When using the network, the index must exist with compatible settings on all remotes.
Response
The document is returned.