Skip to main content
POST

Authorizations

Api-Key
string
header
required

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

Headers

X-Pinecone-Api-Version
string
default:2025-10
required

Required date-based version header

Body

application/json

The request for the update operation.

id
string

Vector's unique id.

Required string length: 1 - 512
Example:

"example-vector-1"

values
number<float>[]

Vector data.

Example:
sparseValues
object

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

setMetadata
object

Metadata to set for the vector.

Example:
namespace
string

The namespace containing the vector to update.

Example:

"example-namespace"

filter
object

A metadata filter expression. When updating metadata across records in a namespace, the update is applied to all records that match the filter. See Understanding metadata.

Example:
dryRun
boolean
default:false

If true, return the number of records that match the filter, but do not execute the update. Default is false.

Example:

false

Response

A successful response.

The response for the update operation.

matchedRecords
integer<int32>

The number of records that matched the filter (if a filter was provided).

Example:

42