Control plane
Describe a collection
This operation gets a description of a collection.
Serverless and starter indexes do not support collections.
GET
/
collections
/
{collection_name}
Authorizations
Api-Key
string
headerrequiredPath Parameters
collection_name
string
requiredThe name of the collection to be described.
Response
200 - application/json
dimension
integer
The dimension of the vectors stored in each record held in the collection.
environment
string
requiredThe environment where the collection is hosted.
name
string
requiredsize
integer
The size of the collection in bytes.
status
enum<string>
requiredThe status of the collection.
Available options:
Initializing
, Ready
, Terminating
vector_count
integer
The number of records stored in the collection.
Was this page helpful?