Skip to main content
POST
/
collections
/
add-collection
Add Collection
curl --request POST \
  --url https://api.zeroentropy.dev/v1/collections/add-collection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection_name": "<string>",
  "num_shards": 1
}
'
{
  "message": "Success!"
}

Authorizations

​
Authorization
string
header
required

The Authorization header must be provided in the format Bearer <your-api-key>.

You can get your API Key at the Dashboard!

Body

application/json
​
collection_name
string
required

The name of the collection to add. The maximum length of this string is 1024 characters. If special characters are used, then the UTF-8 encoded string cannot exceed 1024 bytes.

​
num_shards
integer
default:1

[ADVANCED] The number of shards to use for this collection. By using K shards, your documents can index with K times more throughput. However, queries will be automatically sent to all K shards and then aggregated. For large collections, this can make queries faster. But for small collections, this will make queries slower. num_shards must be one of [1, 8, 16, 32, 64]. The default is 1.

Response

Successful Response

​
message
string
default:Success!

This string will always be "Success!". This may change in the future.