For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETGet collection details
      • PUTCreate a collection
      • DELDelete a collection
      • PATCHUpdate collection parameters
      • GETList all collections
      • GETCheck collection existence
LogoLogo
CloudGitHub
API ReferenceCollections

Create a collection

PUT
/collections/:collection_name
PUT
/collections/:collection_name
$# Create a collection with default dense vector
$curl  -X PUT \
>  'http://localhost:6333/collections/collection_name' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "vectors": {
>    "size": 384,
>    "distance": "Cosine"
>  }
>}'
$
$# Create a collection with named dense and sparse vectors
$curl  -X PUT \
>  'http://localhost:6333/collections/collection_name' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "vectors": {
>    "dense-vector-name": {
>      "size": 1536,
>      "distance": "Cosine"
>    }
>  },
>  "sparse_vectors": {
>    "sparse-vector-name": {
>      "index": {
>        "on_disk": true
>      }
>    }
>  }
>}'
200Updated
1{
2  "usage": {
3    "cpu": 1,
4    "payload_io_read": 1,
5    "payload_io_write": 1,
6    "payload_index_io_read": 1,
7    "payload_index_io_write": 1,
8    "vector_io_read": 1,
9    "vector_io_write": 1
10  },
11  "time": 0.002,
12  "status": "ok",
13  "result": true
14}
Creates a new collection with the given parameters.
Was this page helpful?
Previous

Delete a collection

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the new collection

Query parameters

timeoutintegerOptional

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

Request

Parameters of a new collection
vectorsobject or map from strings to objectsOptional

Vector params separator for single and multiple vector modes Single mode:

{ “size”: 128, “distance”: “Cosine” }

or multiple mode:

{ “default”: { “size”: 128, “distance”: “Cosine” } }

shard_numberuint or nullOptional

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

sharding_methodenum or anyOptional

Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key

replication_factoruint or nullOptional
Number of shards replicas. Default is 1 Minimum is 1
write_consistency_factoruint or nullOptional
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 or nullOptional

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

hnsw_configobject or anyOptional

Custom params for HNSW index. If none - values from service configuration file are used.

wal_configobject or anyOptional

Custom params for WAL. If none - values from service configuration file are used.

optimizers_configobject or anyOptional

Custom params for Optimizers. If none - values from service configuration file are used.

init_fromobject or anyOptional
Specify other collection to copy data from.
quantization_configobject or anyOptional

Quantization parameters. If none - quantization is disabled.

sparse_vectorsmap from strings to objects or nullOptional
Sparse vector data config.
strict_mode_configobject or anyOptional

Strict-mode config.

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultboolean