Fetch vectors

The fetch operation looks up and returns vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata.

For guidance and examples, see Fetch data.

Authorizations

Api-Key

string

header

required

An API Key is required to call Pinecone APIs. Get yours at https://www.pinecone.io/start/

Query Parameters

ids

string[]

required

The vector IDs to fetch. Does not accept values containing spaces.

namespace

string

Response

200

application/json

A successful response.

The response for the fetch operation.

vectors

object

Show child attributes

vectors.{key}

object

Show child attributes

vectors.{key}.id

string

required

This is the vector's unique id.

Required string length: 1 - 512

vectors.{key}.values

number[]

required

This is the vector data included in the request.

vectors.{key}.sparseValues

object

Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.

Show child attributes

vectors.{key}.sparseValues.indices

integer[]

required

The indices of the sparse data.

vectors.{key}.sparseValues.values

number[]

required

The corresponding values of the sparse data, which must be with the same length as the indices.

vectors.{key}.metadata

object

This is the metadata included in the request.

namespace

string

The namespace of the vectors.

usage

object

Show child attributes

usage.readUnits

integer

The number of read units consumed by this operation.