v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB

API Keys

Create an API key

Create an API key for a project to authenticate Data Plane and Control Plane requests.

post/admin/projects/{project_id}/api-keys

Path parameters

project_idstring uuid required

Project ID

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

namestring required

The name of the API key. The name must be 1-80 characters long.

rolesstring[]

The roles to create the API key with. Default is ["ProjectEditor"].

Example request

{
  "name": "devkey",
  "roles": [
    "ProjectEditor"
  ]
}

Response

API key created successfully.

valuestring required

The value to use as an API key. New keys will have the format "pckey_<public-label>_<unique-key>". The entire string should be used when authenticating.

Example response

{
  "key": {
    "roles": [
      "ProjectEditor"
    ]
  }
}