Documentation Index
Fetch the complete documentation index at: https://docs.pinecone.io/llms.txt
Use this file to discover all available pages before exploring further.
Requirements
The Pinecone Java SDK requires Java 1.8 or later.
SDK versions
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 Java SDK versions are as follows:
| API version | SDK version |
|---|
2025-04 | v5.x |
2025-01 | v4.x |
2024-10 | v3.x |
2024-07 | v2.x |
2024-04 | v1.x |
Install
To install the latest version of the Java SDK, add a dependency to the current module:
# Maven
<dependency>
<groupId>io.pinecone</groupId>
<artifactId>pinecone-client</artifactId>
<version>5.0.0</version>
</dependency>
# Gradle
implementation "io.pinecone:pinecone-client:5.0.0"
pinecone-client dependencies separately.
Upgrade
Before upgrading to v4.0.0, update all relevant code to account for the breaking changes explained here. # Maven
<dependency>
<groupId>io.pinecone</groupId>
<artifactId>pinecone-client</artifactId>
<version>5.0.0</version>
</dependency>
# Gradle
implementation "io.pinecone:pinecone-client:5.0.0"
Initialize
Once installed, you can import the SDK and then use an API key to initialize a client instance:
import io.pinecone.clients.Pinecone;
import org.openapitools.db_control.client.model.*;
public class InitializeClientExample {
public static void main(String[] args) {
Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
}
}
Observability
The Java SDK supports capturing per-operation response metadata for all data plane operations, including client-side latency, server processing time, network overhead, and error details. You can use this metadata with OpenTelemetry, Micrometer, or any other observability system to monitor your Pinecone usage in production.
For setup instructions and examples, see OpenTelemetry support.
