Delete documents

To delete every document in a namespace, delete the namespace.

Delete a document

DELETE /namespaces/:namespace/documents/:id

curl -X DELETE \
  https://api.conare.ai/namespaces/docs/documents/refunds \
  -H "Authorization: Bearer $CONARE_API_KEY"

await docs.delete("refunds");

Response

{ "deleted": true }

A missing document returns 404 document_not_found.

Delete many

POST /namespaces/:namespace/documents/delete Deletes documents by id or by filter.

curl https://api.conare.ai/namespaces/docs/documents/delete \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids": ["refunds", "shipping"]}'

curl https://api.conare.ai/namespaces/docs/documents/delete \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filter": {"team": "support"}}'

await docs.deleteMany(["refunds", "shipping"]); // number deleted
await docs.deleteWhere({ team: "support" });    // number deleted

Response

{ "deleted": 2, "more": false }

Request

Send ids or filter, not both.

ids (array): 1-1,000 document ids. Missing ids are skipped.
filter (object): A metadata filter with at least one condition.

Response

deleted: How many documents this call deleted.
more: true if a filter still matches documents. A filter call deletes in batches, so send it again until more is false. The SDK’s deleteWhere does this for you.

Filter keys aren’t checked. A misspelled key matches nothing, so nothing is deleted.

Get started

API

Tools

Delete documents

Delete a document

Delete many

Request

Response

​Delete a document

​Delete many

​Request

​Response

Delete a document

Delete many

Request

Response