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

Set payload

POST
/collections/:collection_name/points/payload
POST
/collections/:collection_name/points/payload
$# Set payload by ID
$curl  -X POST \
>  'http://localhost:6333/collections/collection_name/points/payload' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "payload": {
>    "property1": "some_value",
>    "property2": 32,
>    "property3": true
>  },
>  "points": [
>    0,
>    3,
>    10
>  ]
>}'
$
$# Set payload by filter
$curl  -X POST \
>  'http://localhost:6333/collections/collection_name/points/payload' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "filter": {
>    "must": [
>      {
>        "key": "color",
>        "match": {
>          "value": "red"
>        }
>      }
>    ]
>  },
>  "payload": {
>    "property1": "some_value",
>    "property2": 32,
>    "property3": true
>  }
>}'
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    "status": "acknowledged",
20    "operation_id": 1
21  }
22}
Sets payload values for specified points.
Was this page helpful?
Previous

Overwrite payload

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to set from

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

Set payload on points
payloadmap from strings to anyRequired
pointslist of uint64s or strings or nullOptional
Assigns payload to each point in this list
filterobject or anyOptional
Assigns payload to each point that satisfy this filter condition
shard_keystring or uint64 or list of strings or uint64s or object or anyOptional
keystring or nullOptional
Assigns payload to each point that satisfy this path of property

Response

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