Sign in

v16

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-032765158.3 KB
Collections

Add Collection

Adds a collection.

If the collection already exists, a 409 Conflict status code will be returned.

post/collections/add-collection

Request body

collection_namestring 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_shardsinteger

[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

messagestring

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