Understanding projects

Overview

This document explains the concepts related to Pinecone projects.

Projects contain indexes and users

Each Pinecone project contains a number of indexes and users. Only a user who belongs to the project can access the indexes in that project. Each project also has at least one project owner. All of the pods in a single project are located in a single environment.

Project settings

When you create a new project, you can choose the name, deployment environment, and pod limit.

Project environment

When creating a project, you must choose a cloud environment for the indexes in that project. Your project environment can affect your pricing. The following table lists the available cloud regions, the corresponding values of the environment parameter for the init() operation, and which billing tier has access to each environment:

CloudRegionEnvironmentTier Availability
GCPus-central-1 (Iowa)gcp-starterStarter
GCPus-west-1 (N. California)us-west1-gcp-freeStarter
GCPasia-southeast-1 (Singapore)asia-southeast1-gcp-freeStarter
GCPus-west-4 (Las Vegas)us-west4-gcp-freeStarter
GCPus-west-1 (N. California)us-west1-gcpStandard / Enterprise
GCPus-central-1 (Iowa)us-central1-gcpStandard / Enterprise
GCPus-west-4 (Las Vegas)us-west4-gcpStandard / Enterprise
GCPus-east-4 (Virginia)us-east4-gcpStandard / Enterprise
GCPnorthamerica-northeast-1northamerica-northeast1-gcpStandard / Enterprise
GCPasia-northeast-1 (Japan)asia-northeast1-gcpStandard / Enterprise
GCPasia-southeast-1 (Singapore)asia-southeast1-gcpStandard / Enterprise
GCPus-east-1 (South Carolina)us-east1-gcpStandard / Enterprise
GCPeu-west-1 (Belgium)eu-west1-gcpStandard / Enterprise
GCPeu-west-4 (Netherlands)eu-west4-gcpStandard / Enterprise
AWSus-east-1 (Virginia)us-east-1-awsStandard / Enterprise
Azureeastus (Virginia)eastus-azureStandard / Enterprise

* This environment has unique features and limitations. See gcp-starter environment for more information.

Contact us if you need a dedicated deployment in other regions.

The environment cannot be changed after the project is created.

Project pod limit

You can set the maximum number of pods that can be used in total across all indexes in a project. Use this to control costs.

The pod limit can be changed only by the project owner.

Project roles

There are two project roles: Project owner and project member. Table 1 below summarizes the permissions for each role.

Table 1: Project roles and permissions

Project rolePermissions in organization
Project ownerManage project members
Manage project API keys
Manage pod limits
Project memberAccess API keys
Create indexes in project
Use indexes in project

API keys

Each Pinecone project has one or more API keys. In order to make calls to the Pinecone API, a user must provide a valid API key for the relevant Pinecone project.

To view the API key for your project, open the Pinecone console, select the project, and click API Keys.

Project ID

Each Pinecone project has a project ID. This hexadecimal string appears as part of the URL for API calls.

To find a project's ID, follow these steps:

  1. Go to the Pinecone console.

  2. In the upper-left corner, select your project.

  3. Click Indexes.

  4. Under the name of your indexes, find the index URL. For example:

    example-index-1e3g52e.svc.us-east1-gcp.pinecone.io

The portion of the index URL after the index name and before the dot is the project ID.

For example, in the index URL test-index-3e2f43f.svc.us-east1-gcp.pinecone.io, the project ID is 3e2f43f.