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
LogoLogo
CloudGitHub
API ReferencePoints

Clear payload

POST
/collections/:collection_name/points/payload/clear
POST
/collections/:collection_name/points/payload/clear
$curl -X POST http://localhost:6333/collections/collection_name/points/payload/clear \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "filter": {}
>}'
200Successful
1{
2  "time": 1.1,
3  "status": "string",
4  "result": {
5    "status": "acknowledged",
6    "operation_id": 1
7  }
8}
Removes the entire payload for specified points.
Was this page helpful?
Previous

Batch update points

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to clear payload from

Query parameters

waitbooleanOptional
If true, wait for changes to actually happen
orderingenumOptional
define ordering guarantees for the operation
Allowed values:

Request

clear payload on points
PointIdsListobjectRequired
OR
FilterSelectorobjectRequired

Response

successful operation
timedouble
Time spent to process this request
statusstring
resultobject