/admin/projectsCreate a new projectCreate a new project.
Parameters
X-Pinecone-Api-VersionstringheaderrequiredRequired date-based version header
Request body
requiredThe details of the new project.
application/json
force_encryption_with_cmekbooleanWhether to force encryption with a customer-managed encryption key (CMEK). Default is `false`.
max_podsintegerThe maximum number of Pods that can be created in the project. Default is `0` (serverless only).
namestringrequiredThe name of the new project.
{
"force_encryption_with_cmek": true,
"max_pods": 0,
"name": "chatbot-prod"
}Responses
The details of a project.
created_atstring · date-timeThe date and time when the project was created.
force_encryption_with_cmekbooleanrequiredWhether to force encryption with a customer-managed encryption key (CMEK).
idstring · uuidrequiredThe unique ID of the project.
max_podsintegerrequiredThe maximum number of Pods that can be created in the project.
namestringrequiredThe name of the project.
organization_idstringrequiredThe unique ID of the organization that the project belongs to.
{
"created_at": "2026-06-09T00:00:00Z",
"force_encryption_with_cmek": true,
"id": "00000000-0000-0000-0000-000000000000",
"max_pods": 0,
"name": "string",
"organization_id": "string"
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe error code. Possible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `UNIMPLEMENTED`, `INTERNAL`, `UNAVAILABLE`, `DATA_LOSS`, `FORBIDDEN`, or `UNPROCESSABLE_ENTITY`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Bad request. The request body included invalid request parameters."
},
"status": 400
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe error code. Possible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `UNIMPLEMENTED`, `INTERNAL`, `UNAVAILABLE`, `DATA_LOSS`, `FORBIDDEN`, or `UNPROCESSABLE_ENTITY`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid API key."
},
"status": 401
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe error code. Possible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `UNIMPLEMENTED`, `INTERNAL`, `UNAVAILABLE`, `DATA_LOSS`, `FORBIDDEN`, or `UNPROCESSABLE_ENTITY`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
},
"status": 429
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe error code. Possible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `UNIMPLEMENTED`, `INTERNAL`, `UNAVAILABLE`, `DATA_LOSS`, `FORBIDDEN`, or `UNPROCESSABLE_ENTITY`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
},
"status": 429
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe error code. Possible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `UNIMPLEMENTED`, `INTERNAL`, `UNAVAILABLE`, `DATA_LOSS`, `FORBIDDEN`, or `UNPROCESSABLE_ENTITY`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
},
"status": 429
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe error code. Possible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `UNIMPLEMENTED`, `INTERNAL`, `UNAVAILABLE`, `DATA_LOSS`, `FORBIDDEN`, or `UNPROCESSABLE_ENTITY`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}