v17

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-2575397522.8 KB

Collections

Create collection

Create new collection with given parameters

put/collections/{collection_name}

Path parameters

collection_namestring required

Name of the new collection

Query parameters

timeoutinteger

Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Request body

shard_numberinteger nullable

For auto sharding: Number of shards in collection. - Default is 1 for standalone, otherwise equal to the number of nodes - Minimum is 1

For custom sharding: Number of shards in collection per shard group. - Default is 1, meaning that each shard key will be mapped to a single shard - Minimum is 1

replication_factorinteger nullable

Number of shards replicas. Default is 1 Minimum is 1

write_consistency_factorinteger nullable

Defines how many replicas should apply the operation for us to consider it successful. Increasing this number will make the collection more resilient to inconsistencies, but will also make it fail if not enough replicas are available. Does not have any performance impact.

on_disk_payloadboolean nullable

If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM.

Default: true

sparse_vectorsobject nullable

Sparse vector data config.

Example request

{
  "metadata": {
    "city": "London",
    "color": "green"
  }
}

Response

successful operation

timenumber float

Time spent to process this request

statusstring

resultboolean

Example response

{
  "time": 0.002,
  "status": "ok"
}