Pinecone’s Database and Inference APIs are versioned to ensure that your applications continue to work as expected as the platform evolves. Versions are named by release date in the format YYYY-MM, for example, 2024-10.

The Pinecone Assistant API is not versioned. Pinecone Assistant in public preview and is not recommended for production usage.

​
Release schedule

On a quarterly basis, Pinecone releases a new stable API version as well as a release candidate of the next stable version.

  • Stable: Each stable version remains unchanged and supported for a minimum of 12 months. Since stable versions are released every 3 months, this means you have at least 9 months to test and migrate your app to the newest stable version before support for the previous version is removed.

  • Release candidate: The release candidate gives you insight into the upcoming changes in the next stable version. It is available for approximately 3 months before the release of the stable version and can include new features, improvements, and breaking changes.

Below is an example of Pinecone’s release schedule:

​
Specify an API version

When using the API directly, it is important to specify an API version in your requests. If you don’t, requests default to the oldest supported stable version. Once support for that version ends, your requests will default to the next oldest stable version, which could include breaking changes that require you to update your integration.

To specify an API version, set the X-Pinecone-API-Version header to the version name.

For example, based on the version support diagram above, if it is currently July 2024 and you want to use the latest stable version to describe an index, you would set "X-Pinecone-API-Version: 2024-07":

curl
PINECONE_API_KEY="YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/indexes/movie-recommendations" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-API-Version: 2024-07"

If you want to use the release candidate of the next stable version instead, you would set "X-Pinecone-API-Version: 2024-10":

curl
PINECONE_API_KEY="YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/indexes/movie-recommendations" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-API-Version: 2024-10"

​
SDK versions

Official Pinecone SDKs provide convenient access to Pinecone APIs. SDK versions are pinned to specific API versions. When a new API version is released, a new version of the SDK is also released.

The mappings between API versions and SDK versions are as follows:

2024-042024-072024-10
Python SDKv4.xv5.0.x-v5.2.xv5.3.x
Node.js SDKv2.xv3.xv4.x
Java SDKv1.xv2.xv3.x
Go SDKv0.xv1.xv2.x
.NET SDKv0.xv1.xcoming soon

When a new stable API version is released, you should upgrade your SDK to the latest version to ensure compatibility with the latest API changes.

​
Breaking changes

Breaking changes are changes that can potentially break your integration with a Pinecone API. Breaking changes include:

  • Removing an entire operation
  • Removing or renaming a parameter
  • Removing or renaming a response field
  • Adding a new required parameter
  • Making a previously optional parameter required
  • Changing the type of a parameter or response field
  • Removing enum values
  • Adding a new validation rule to an existing parameter
  • Changing authentication or authorization requirements

​
Non-breaking changes

Non-breaking changes are additive and should not break your integration. Additive changes include:

  • Adding an operation
  • Adding an optional parameter
  • Adding an optional request header
  • Adding a response field
  • Adding a response header
  • Adding enum values

​
Get updates

To ensure you always know about upcoming API changes, follow the Release notes.

Was this page helpful?

ErrorsUpsert vectors