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.
# 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
}'{
"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
Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Headers
Section titled “Headers”X-Pinecone-Api-VersionstringrequiredRequired date-based version header
namespace?stringThe namespace to fetch vectors from.
Example: example-namespace
filter?objectMetadata filter expression to select vectors. See Understanding metadata.
limit?integerMax number of vectors to return.
Required range: 1 <= x. Example: 12
paginationToken?stringPagination token to continue a previous listing operation.
Example: Tm90aGluZyB0byBzZWUgaGVyZQo=
Response
Section titled “Response”200 — A successful response.
The response for the fetch_by_metadata operation.
vectors?objectThe fetched vectors, in the form of a map between the fetched ids and the fetched vectors
namespace?stringThe namespace of the vectors.
Example: example-namespace
usage?objectShow child attributes
readUnits?integerThe number of read units consumed by this operation.
Example: 5
pagination?objectShow child attributes
next?stringExample: Tm90aGluZyB0byBzZWUgaGVyZQo=