Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

Fetch vectors by metadata

Look up and return vectors by metadata filter from a single namespace. The returned vectors include the vector data and/or metadata.

For guidance and examples, see Fetch data.

curl
# To get the unique host for an index,
# see https://docs.pinecone.io/guides/manage-data/target-an-index
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"

curl -X POST "https://$INDEX_HOST/vectors/fetch_by_metadata" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Pinecone-Api-Version: 2025-10" \
  -d '{
    "namespace": "__default__",
    "filter": {"genre": {"$eq": "Action/Adventure"}},
    "limit": 2
  }'
curl
{
  "vectors": {
    "0": {
      "id": "0",
      "values": [
        0.0234527588, 0.0291595459 ...
      ],
      "metadata": {
        "box-office": 2923706026,
        "genre": "Action/Adventure",
        "summary": "On the alien world of Pandora, paraplegic Marine Jake Sully uses an avatar to walk again and becomes torn between his mission and protecting the planet's indigenous Na'vi people. The film stars Sam Worthington, Zoe Saldana, and Sigourney Weaver.",
        "title": "Avatar",
        "year": 2009
      }
    },
    "1": {
      "id": "1",
      "values": [
        0.0397644043, 0.013053894, ...
      ],
      "metadata": {
        "box-office": 2799439100,
        "genre": "Action/Adventure",
        "summary": "In the aftermath of Thanos wiping out half of the universe, the remaining Avengers assemble once more to undo the chaos, leading to a time-traveling adventure. Stars Robert Downey Jr., Chris Evans, and Scarlett Johansson.",
        "title": "Avengers: Endgame",
        "year": 2019
      }
    }
  },
  "namespace": "__default__",
  "usage": {
    "readUnits": 1
  },
  "pagination": {
    "next": "Tm90aGluZyB0byBzZWUgaGVyZQo="
  }
}

POST /vectors/fetch_by_metadata

Api-Keystringrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2025-10
namespace?string

The namespace to fetch vectors from.

Example: example-namespace

Typestring
filter?object

Metadata filter expression to select vectors. See Understanding metadata.

limit?integer

Max number of vectors to return.

Required range: 1 <= x. Example: 12

Typeinteger
Default100
paginationToken?string

Pagination token to continue a previous listing operation.

Example: Tm90aGluZyB0byBzZWUgaGVyZQo=

Typestring

200 — A successful response.

The response for the fetch_by_metadata operation.

vectors?object

The fetched vectors, in the form of a map between the fetched ids and the fetched vectors

Typeobject
namespace?string

The namespace of the vectors.

Example: example-namespace

Typestring
usage?object
Show child attributes
readUnits?integer

The number of read units consumed by this operation.

Example: 5

Typeinteger
pagination?object
Show child attributes
next?string

Example: Tm90aGluZyB0byBzZWUgaGVyZQo=

Typestring
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu