Create a collection

This operation creates a Pinecone collection.

Serverless and starter indexes do not support collections.

Authorizations

Api-Key

string

headerrequired

Body

application/json

The configuration needed to create a Pinecone collection.

name

string

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 '-'.

Required string length: 1 - 45

source

string

required

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

Response

201 - application/json

The CollectionModel describes the configuration and status of a Pinecone collection.

name

string

required

status

enum<string>

required

The status of the collection.

Available options:

Initializing,

Ready,

Terminating

environment

string

required

The environment where the collection is hosted.

size

integer

The size of the collection in bytes.

dimension

integer

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

Required range: 1 < x < 2000

vector_count

integer

The number of records stored in the collection.