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
      • PUTCreate named vector
      • DELDelete named vector
      • GETGet optimization progress
LogoLogo
CloudGitHub
API ReferenceCollections

Update collection parameters

PATCH
/collections/:collection_name
PATCH
/collections/:collection_name
$curl  -X PATCH \
>  'http://localhost:6333/collections/collection_name' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "optimizers_config": {
>    "indexing_threshold": 10000
>  }
>}'
200Updated
1{
2  "usage": {
3    "hardware": {
4      "cpu": 1,
5      "payload_io_read": 1,
6      "payload_io_write": 1,
7      "payload_index_io_read": 1,
8      "payload_index_io_write": 1,
9      "vector_io_read": 1,
10      "vector_io_write": 1
11    },
12    "inference": {
13      "models": {}
14    }
15  },
16  "time": 0.002,
17  "status": "ok",
18  "result": true
19}
Updates the parameters of the specified collection.
Was this page helpful?
Previous

List all collections

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to update

Query parameters

timeoutintegerOptional>=1

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

Request

New parameters
vectorsmap from strings to objects or anyOptional
Map of vector data parameters to update for each named vector. To update parameters in a collection having a single unnamed vector, use an empty string as name.
optimizers_configobject or anyOptional

Custom params for Optimizers. If none - it is left unchanged. This operation is blocking, it will only proceed once all current optimizations are complete

paramsobject or anyOptional

Collection base params. If none - it is left unchanged.

hnsw_configobject or anyOptional

HNSW parameters to update for the collection index. If none - it is left unchanged.

quantization_configobject or enum or anyOptional

Quantization parameters to update. If none - it is left unchanged.

sparse_vectorsmap from strings to objects or anyOptional
Map of sparse vector data parameters to update for each sparse vector.
strict_mode_configobject or anyOptional
metadatamap from strings to any or anyOptional
Metadata to update for the collection. If provided, this will merge with existing metadata. To remove metadata, set it to an empty object.

Response

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