POST
/
collections

Authorizations

Api-Key
string
headerrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

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

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

The name of the collection.

size
integer

The size of the collection in bytes.

status
enum<string>
required

The status of the collection.

Available options:
Initializing,
Ready,
Terminating
dimension
integer

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

vector_count
integer

The number of records stored in the collection.

environment
string
required

The environment where the collection is hosted.