---
title: Query Vectors
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Vectorize](https://developers.cloudflare.com/api/resources/vectorize)
[Indexes](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Query Vectors
POST/accounts/{account\_id}/vectorize/v2/indexes/{index\_name}/query
Finds vectors closest to a given vector in an index.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Vectorize Write``Vectorize Read`
##### P ath ParametersExpand Collapse
account\_id: string
Identifier
maxLength32
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
index\_name: string
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(params)%20default%20%3E%20(param)%20index_name%20%3E%20(schema)>)
##### Body ParametersJSONExpand Collapse
vector: array of number
The search vector that will be used to find the nearest neighbors.
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(params)%200%20%3E%20(param)%20vector%20%3E%20(schema)>)
filter: optional unknown
A metadata filter expression used to limit nearest neighbor results.
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(params)%200%20%3E%20(param)%20filter%20%3E%20(schema)>)
returnMetadata: optional "none"or "indexed"or "all"
Whether to return no metadata, indexed metadata or all metadata associated with the closest vectors.
One of the following:
"none"
Link to this property
"indexed"
Link to this property
"all"
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(params)%200%20%3E%20(param)%20returnMetadata%20%3E%20(schema)>)
returnValues: optional boolean
Whether to return the values associated with the closest vectors.
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(params)%200%20%3E%20(param)%20returnValues%20%3E%20(schema)>)
topK: optional number
The number of nearest neighbors to find.
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(params)%200%20%3E%20(param)%20topK%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: object {count, matches }
count: optional number
Specifies the count of vectors returned by the search
Link to this property
matches: optional array of object {id, metadata, namespace, 2 more }
Array of vectors matched by the search
id: optional string
Identifier for a Vector
maxLength64
Link to this property
metadata: optional unknown
Link to this property
namespace: optional string
Link to this property
score: optional number
The score of the vector according to the index’s distance metric
Link to this property
values: optional array of number
Link to this property
Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Whether the API call was successful
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20query%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Query Vectors
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/vectorize/v2/indexes/$INDEX_NAME/query \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{
"vector": [
0.5,
0.5,
0.5
],
"filter": {
"has_viewed": {
"$ne": true
},
"streaming_platform": "netflix"
},
"topK": 5
}'
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"count": 0,
"matches": [
{
"id": "some-vector-id-023e105f4ecef8ad9ca31a8372d0c353",
"metadata": {},
"namespace": "namespace",
"score": 0,
"values": [
0
]
}
]
},
"success": true
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"count": 0,
"matches": [
{
"id": "some-vector-id-023e105f4ecef8ad9ca31a8372d0c353",
"metadata": {},
"namespace": "namespace",
"score": 0,
"values": [
0
]
}
]
},
"success": true
}
```