Attribute usage to your integration
Attribute Pinecone SDK and REST usage to your integration with source tags and User-Agent values so support and analytics can trace traffic to your product.
Once you have created your integration with Pinecone, specify a source tag when instantiating clients with Pinecone SDKs, or pass a source tag as part of the User-Agent header when using the API directly.
Source tag naming conventions
Section titled “Source tag naming conventions”Your source tag must follow these conventions:
- Clearly identify your integration.
- Use only lowercase letters, numbers, underscores, and colons.
For example, for an integration called "New Framework", "new_framework" is valid, but "new framework" and "New_framework" aren't valid.
Specify a source tag
Section titled “Specify a source tag”# REST client
from pinecone import Pinecone
pc = Pinecone(
api_key="YOUR_API_KEY",
source_tag="YOUR_SOURCE_TAG"
)
# gRPC client
from pinecone.grpc import PineconeGRPC
pc = PineconeGRPC(
api_key="YOUR_API_KEY",
source_tag="YOUR_SOURCE_TAG"
)import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone({
apiKey: 'YOUR_API_KEY',
sourceTag: 'YOUR_SOURCE_TAG'
});import io.pinecone.clients.Pinecone;
public class IntegrationExample {
public static void main(String[] args) {
Pinecone pc = new Pinecone.Builder("YOUR_API_KEY")
.withSourceTag("YOUR_SOURCE_TAG")
.build();
}
}import "github.com/pinecone-io/go-pinecone/v4/pinecone"
client, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: "YOUR_API_KEY",
SourceTag: "YOUR_SOURCE_TAG",
})curl -i -X GET "https://api.pinecone.io/indexes" \
-H "Accept: application/json" \
-H "Api-Key: YOUR_API_KEY" \
-H "User-Agent: source_tag=YOUR_SOURCE_TAG" \
-H "X-Pinecone-Api-Version: 2025-10"