Back to Pinecone Python Client

Authentication

docs/getting-started/authentication.md

9.0.01.4 KB
Original Source

Authentication

Getting an API key

Sign in to the Pinecone console, navigate to API Keys, and create or copy an existing key.

Set PINECONE_API_KEY before running your application:

bash
export PINECONE_API_KEY=your-key-here

The client reads it automatically when you call Pinecone() with no arguments:

python
from pinecone import Pinecone

pc = Pinecone()

Explicit argument

Pass the key directly if you manage secrets through your own mechanism:

python
from pinecone import Pinecone

pc = Pinecone(api_key="your-key-here")

Missing key error

If no API key can be resolved — neither from the argument nor from the environment variable — the client raises PineconeConfigurationError on construction:

python
from pinecone import Pinecone, PineconeConfigurationError

try:
    pc = Pinecone()
except PineconeConfigurationError as e:
    print(e)  # "No API key provided. Pass api_key='...' or set the PINECONE_API_KEY env var."

Security best practices

Never hardcode API keys in source files. Use environment variables or a secrets manager. As a lightweight alternative, the python-dotenv package loads a local .env file (which you add to .gitignore):

bash
pip install python-dotenv
python
from dotenv import load_dotenv
from pinecone import Pinecone

load_dotenv()  # reads PINECONE_API_KEY from .env
pc = Pinecone()