Authentication
All requests to Pinecone APIs must contain a valid API key for the target project.
Get an API key
Create a new API key in the Pinecone console, or use the connect widget below to generate a key.
Copy your generated key:
Initialize a client
When using a Pinecone SDK, initialize a client object with your API key and then reuse the authenicated client in subsquent function calls. For example:
Add headers to an HTTP request
All HTTP requests to Pinecone APIs must contain an Api-Key
header that specifies a valid API key and must be encoded as JSON with the Content-Type: application/json
header. For example:
Troubleshooting
Initialization errors due to outdated SDKs
Initialization errors due to outdated SDKs
Older versions of Pinecone required you to initialize a client with an init
method that takes both api_key
and environment
parameters, for example:
In more recent versions of Pinecone, this has changed. Initialization no longer requires an init
step, and cloud environment is defined for each index rather than an entire project. Client initialization now only requires an api_key
parameter, for example:
If you are receiving errors about initialization, upgrade your Pinecone SDK to the latest version, for example:
Also, note that some third-party tutorials and examples still reference the older initialization method. In such cases, follow the example above and the examples throughout the Pinecone documentation instead.