Control plane
Create a collection
Control plane
Create a collection
This operation creates a Pinecone collection.
Serverless indexes do not support collections.
POST
/
collections
Authorizations
Api-Key
string
headerrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Body
application/json
name
string
requiredThe 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
requiredThe name of the index to be used as the source for the collection.
Response
201 - application/json
name
string
requiredThe name of the collection.
size
integer
The size of the collection in bytes.
status
enum<string>
requiredThe 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
requiredThe environment where the collection is hosted.
Was this page helpful?