POST
/
collections
PINECONE_API_KEY = "YOUR_API_KEY"

curl -s -X POST "https://api.pinecone.io/collections" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -d '{
        "name": "example-collection",
        "source": "example-index"
  }'

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

Authorizations

Api-Key
string
headerrequired

Body

application/json
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
name
string
required
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.

Was this page helpful?

List collectionsDescribe a collection