Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB
Manage Indexes

Create a collection

Create a Pinecone collection.

Serverless indexes do not support collections.

post/collections

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

namestring required

The name of the collection to be created. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

sourcestring required

The name of the index to be used as the source for the collection.

Example request

{
  "source": "example-source-index"
}

Response

The collection has been successfully created.

namestring required

The name of the collection.

sizeinteger

The size of the collection in bytes.

statusstring required

The status of the collection. Possible values: Initializing, Ready, or Terminating.

dimensioninteger

The dimension of the vectors stored in each record held in the collection.

vector_countinteger

The number of records stored in the collection.

environmentstring required

The environment where the collection is hosted.

Example response

{
  "name": "example-collection",
  "size": 10000000,
  "status": "Initializing",
  "dimension": 1536,
  "vector_count": 120000,
  "environment": "us-east1-gcp"
}