Set payload

POST

Sets payload values for specified points.

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: weakmediumstrong

Request

This endpoint expects an object.

payloadmap from strings to anyRequired

pointslist of integers or stringsOptional

Assigns payload to each point in this list

filterobject or anyOptional

Assigns payload to each point that satisfy this filter condition

shard_keystring or integer or list of strings or integers or anyOptional

keystringOptional

Assigns payload to each point that satisfy this path of property

Response

This endpoint returns an object.

usageobject or anyOptional

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

POST

1 # Set payload by ID
2 curl  -X POST \
3   'http://localhost:6333/collections/collection_name/points/payload' \
4   --header 'api-key: <api-key-value>' \
5   --header 'Content-Type: application/json' \
6   --data-raw '{
7   "payload": {
8     "property1": "some_value",
9     "property2": 32,
10     "property3": true
11   },
12   "points": [
13     0,
14     3,
15     10
16   ]
17 }'
18 
19 # Set payload by filter
20 curl  -X POST \
21   'http://localhost:6333/collections/collection_name/points/payload' \
22   --header 'api-key: <api-key-value>' \
23   --header 'Content-Type: application/json' \
24   --data-raw '{
25   "filter": {
26     "must": [
27       {
28         "key": "color",
29         "match": {
30           "value": "red"
31         }
32       }
33     ]
34   },
35   "payload": {
36     "property1": "some_value",
37     "property2": 32,
38     "property3": true
39   }
40 }'

200Successful

1 {
2   "usage": {
3     "cpu": 1,
4     "io_read": 1,
5     "io_write": 1
6   },
7   "time": 0.002,
8   "status": "ok",
9   "result": {
10     "status": "acknowledged",
11     "operation_id": 1
12   }
13 }

Overwrite payload

Up Next

Built with

1	# Set payload by ID
2	curl -X POST \
3	'http://localhost:6333/collections/collection_name/points/payload' \
4	--header 'api-key: <api-key-value>' \
5	--header 'Content-Type: application/json' \
6	--data-raw '{
7	"payload": {
8	"property1": "some_value",
9	"property2": 32,
10	"property3": true
11	},
12	"points": [
13	0,
14	3,
15	10
16	]
17	}'
18
19	# Set payload by filter
20	curl -X POST \
21	'http://localhost:6333/collections/collection_name/points/payload' \
22	--header 'api-key: <api-key-value>' \
23	--header 'Content-Type: application/json' \
24	--data-raw '{
25	"filter": {
26	"must": [
27	{
28	"key": "color",
29	"match": {
30	"value": "red"
31	}
32	}
33	]
34	},
35	"payload": {
36	"property1": "some_value",
37	"property2": 32,
38	"property3": true
39	}
40	}'

1	{
2	"usage": {
3	"cpu": 1,
4	"io_read": 1,
5	"io_write": 1
6	},
7	"time": 0.002,
8	"status": "ok",
9	"result": {
10	"status": "acknowledged",
11	"operation_id": 1
12	}
13	}