Skip to main content
POST
/
api
/
v2
/
tenants
/
{tenant}
/
databases
/
{database}
/
collections
/
{collection_id}
/
upsert
cURL
curl --request POST \
  --url https://api.trychroma.com/api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/upsert \
  --header 'Content-Type: application/json' \
  --header 'x-chroma-token: <api-key>' \
  --data '
{
  "embeddings": [
    [
      123
    ]
  ],
  "ids": [
    "<string>"
  ],
  "documents": [
    "<string>"
  ],
  "metadatas": [
    "<unknown>"
  ],
  "uris": [
    "<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 upserting records in a collection.

Upsert creates records if they don't exist, or updates them if they do. Records are added in batches. All arrays must have the same length, with each index representing a single record. For example, ids[0], embeddings[0], documents[0], etc. all belong to the same record.

​
embeddings
required

Embeddings for each record. Can contain the raw f32 arrays or base64 encoded strings.

​
ids
string[]
required
​
documents
(string | null)[] | null
​
metadatas
(null | object)[] | null
​
uris
(string | null)[] | null

Response

Records upserted successfully

The response is of type object.