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
      • POSTRetrieve points
      • PUTUpsert points
      • GETRetrieve a point
      • POSTDelete points
      • PUTUpdate vectors
      • POSTDelete vectors
      • POSTSet payload
      • PUTOverwrite payload
      • POSTDelete payload
      • POSTClear payload
      • POSTBatch update points
      • POSTScroll points
      • POSTCount points
      • POSTPayload field facets
LogoLogo
CloudGitHub
API ReferencePoints

Batch update points

POST
/collections/:collection_name/points/batch
POST
/collections/:collection_name/points/batch
$curl  -X POST \
>  'http://localhost:6333/collections/collection_name/points/batch' \
>  --header 'Content-Type: application/json' \
>  --header 'api-key: <api-key-value>' \
>  --data-raw '{
>  "operations": [
>    {
>      "upsert": {
>        "points": [
>          {
>            "id": 1,
>            "vector": [
>              0.4,
>              0.3,
>              0.2,
>              0.1
>            ]
>          }
>        ]
>      }
>    },
>    {
>      "update_vectors": {
>        "points": [
>          {
>            "id": 1,
>            "vector": [
>              0.11,
>              0.22,
>              0.33,
>              0.44
>            ]
>          }
>        ]
>      }
>    },
>    {
>      "set_payload": {
>        "payload": {
>          "test_payload_2": 2,
>          "test_payload_3": 3
>        },
>        "points": [
>          1
>        ]
>      }
>    }
>  ]
>}'
200Successful
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": [
19    {
20      "status": "acknowledged",
21      "operation_id": 1
22    }
23  ]
24}
Batch updates points, including their respective vectors and payloads.
Was this page helpful?
Previous

Scroll points

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to apply operations on

Query parameters

waitbooleanOptional
If true, wait for changes to actually happen
orderingenumOptional
define ordering guarantees for the operation
Allowed values:
timeoutintegerOptional>=1
Timeout for the operation

Request

update operations
operationslist of objectsRequired

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultlist of objects