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.
Each Pinecone project has one or more API keys. In order to make calls to the Pinecone API, you must provide a valid API key for the relevant Pinecone project.
This page shows you how to create, view, change permissions for, and delete API keys.
If you use custom API key permissions, ensure that you target your index by host when performing data operations such as upsert and query. Create an API key
You can create a new API key for your project, as follows:
-
Open the Pinecone console.
-
Select your project.
-
Go to API keys.
-
Click Create API key.
-
Enter an API key name.
-
Select the Permissions to grant to the API key. For a description of the permission roles, see API key permissions.
-
Click Create key.
-
Copy and save the generated API key in a secure place for future use.
You will not be able to see the API key again after you close the dialog.
-
Click Close.
An access token must be provided to complete this action through the Admin API. PINECONE_PROJECT_ID="YOUR_PROJECT_ID"
PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
curl -X POST "https://api.pinecone.io/admin/projects/$PINECONE_PROJECT_ID/api-keys" \
-H "X-Pinecone-Api-Version: 2025-10" \
-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
-d '{
"name": "example-api-key",
"roles": ["ProjectEditor"]
}'
{
"key": {
"id": "62b0dbfe-3489-4b79-b850-34d911527c88",
"name": "example-api-key",
"project_id": "32c8235a-5220-4a80-a9f1-69c24109e6f2",
"roles": [
"ProjectEditor"
],
"created_at": "2025-10-20T23:40:27.069075Z"
},
"value": "..."
}
View project API keys
You can view the API keys for your project:
- Open the Pinecone console.
- Select your project.
- Go to the API keys tab.
You will see a list of all API keys for the project, including their names, IDs, and permissions.An access token must be provided to complete this action through the Admin API. PINECONE_PROJECT_ID="32c8235a-5220-4a80-a9f1-69c24109e6f2"
PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
curl -X GET "https://api.pinecone.io/admin/projects/$PINECONE_PROJECT_ID/api-keys" \
-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
-H "X-Pinecone-Api-Version: 2025-10"
{
"data": [
{
"id": "62b0dbfe-3489-4b79-b850-34d911527c88",
"name": "example-api-key",
"project_id": "32c8235a-5220-4a80-a9f1-69c24109e6f2",
"roles": [
"ProjectEditor"
],
"created_at": "2025-10-20T23:39:43.665754Z"
},
{
"id": "0d0d3678-81b4-4e0d-a4f0-70ba488acfb7",
"name": "example-api-key-2",
"project_id": "32c8235a-5220-4a80-a9f1-69c24109e6f2",
"roles": [
"ProjectEditor"
],
"created_at": "2025-10-20T23:43:13.176422Z"
}
]
}
View API key details
You can view the details of an API key:
- Open the Pinecone console.
- Select your project.
- Go to the API keys tab.
- In the row of the API key you want to change, in the Actions column, click ellipsis (…) menu > Settings.
You will see the API key’s name, ID, and permissions.An access token must be provided to complete this action through the Admin API. PINECONE_API_KEY_ID="62b0dbfe-3489-4b79-b850-34d911527c88"
PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
curl -X GET "https://api.pinecone.io/admin/api-keys/$PINECONE_API_KEY_ID" \
-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
-H "accept: application/json" \
-H "X-Pinecone-Api-Version: 2025-10"
{
"id": "62b0dbfe-3489-4b79-b850-34d911527c88",
"name": "example-api-key",
"project_id": "32c8235a-5220-4a80-a9f1-69c24109e6f2",
"roles": [
"ProjectEditor"
],
"created_at": "2025-10-22T19:27:21.202955Z"
}
Update an API key
If you are a project owner, you can update the name and roles of an API key:
-
Open the Pinecone console.
-
Select your project.
-
Go to the API keys tab.
-
In the row of the API key you want to change, in the Actions column, click ellipsis (…) menu > Settings.
-
Change the name and/or permissions for the API key as needed.
For information about the different API key permissions, refer to Understanding security - API keys.
-
Click Update.
An access token must be provided to complete this action through the Admin API. PINECONE_API_KEY_ID="62b0dbfe-3489-4b79-b850-34d911527c88"
PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
curl -X PATCH "https://api.pinecone.io/admin/api-keys/$PINECONE_API_KEY_ID" \
-H "X-Pinecone-Api-Version: 2025-10" \
-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
-d '{
"name": "new-api-key-name",
"roles": ["ProjectEditor"]
}'
{
"id": "62b0dbfe-3489-4b79-b850-34d911527c88",
"name": "new-api-key-name",
"project_id": "32c8235a-5220-4a80-a9f1-69c24109e6f2",
"roles": [
"ProjectEditor"
],
"created_at": "2025-10-22T19:27:21.202955Z"
}
Delete an API key
If you are a project owner, you can delete your API key:
-
Open the Pinecone console.
-
Select your project.
-
Go to the API keys tab.
-
In the row of the API key you want to change, in the Actions column, click ellipsis (…) menu > Delete.
-
Enter the API key name.
-
Click Confirm deletion.
Deleting an API key is irreversible and will immediately disable any applications using the API key.
An access token must be provided to complete this action through the Admin API. PINECONE_API_KEY_ID="62b0dbfe-3489-4b79-b850-34d911527c88"
PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
curl -X DELETE "https://api.pinecone.io/admin/api-keys/$PINECONE_API_KEY_ID" \
-H "X-Pinecone-Api-Version: 2025-10" \
-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN"
