Delete records

collection.delete(ids=['id1', 'id2'])

{
  "deleted": 1
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

POST

api

tenants

{tenant}

databases

{database}

collections

{collection_id}

delete

collection.delete(ids=['id1', 'id2'])

{
  "deleted": 1
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

x-chroma-token

string

header

required

Path Parameters

tenant

string

required

Tenant UUID

database

string

required

Database name

collection_id

string

required

Collection UUID

Body

application/json

Payload for deleting records from a collection.

Records can be deleted by their IDs or by a metadata filter. At least one of ids or where must be provided.

where

any

where_document

any

ids

string[] | null

limit

integer<int32> | null

Required range: x >= 0

Response

Records deleted successfully

deleted

integer<int32>

Required range: x >= 0

Get number of records

Get indexing status

⌘I

Self-Hosted Chroma

SDKs

Beta SDKs

APIs

Dictionary Syntax

Architecture

Authorizations

Path Parameters

Body

Response