Skip to main content
The Chroma node adds Chroma operations to your workflows. Add it on the canvas or ask the AI builder for it by name, then pick an operation and fill in its fields.
You can wire the Chroma node into an AI agent as a tool provider: the agent calls the operations you allow. See Agent tools.

Credentials

Connect Chroma under Credentials in the node settings. See Connecting credentials for the general flow. Enter the values manually when creating the credential. Get your credentials here.

Operations

Collection

OperationIDDescription
Count Collectionscount_collectionsCount the total number of collections in the database.
Create Collectioncreate_collectionCreate a collection.
Delete Collectiondelete_collectionPermanently delete a collection and all its records.
Fork Collectionfork_collectionFork (copy) an existing collection into a new one.
Fork Countfork_countGet the number of times a collection has been forked.
Get Collectionget_collectionGet a collection’s metadata and configuration by name.
Get Collection by CRNget_collection_by_crnGet a collection by its Cloud Resource Name (CRN).
Get Collection by IDget_collection_by_idGet a collection’s metadata by its UUID.
Indexing Statusindexing_statusGet the indexing status of a collection (records indexed vs pending).
List Collectionslist_collectionsList collections in the tenant/database.
Update Collectionupdate_collectionRename a collection or replace its metadata.

Database

OperationIDDescription
Create Databasecreate_databaseCreate a new database in the tenant.
Delete Databasedelete_databaseDelete a database and ALL its collections. DESTRUCTIVE.
Get Databaseget_databaseGet metadata about a database.
List Databaseslist_databasesList all databases in the tenant.

Functions

OperationIDDescription
Add Function Inputadd_attached_function_inputAdd input data to an attached function (e.g. provide documents to embed).
Attach Functionattach_functionAttach an embedding or processing function to a collection.
Detach Functiondetach_functionDetach (remove) a function from a collection.
Get Attached Functionget_attached_functionGet details about a function attached to a collection.

Records

OperationIDDescription
Add RecordsaddAdd records to a collection (fails if IDs already exist; use Upsert for insert-or-update).
Count RecordscountCount the number of records in a collection.
Delete RecordsdeleteDelete records by ID, metadata filter, or document content filter.
Get RecordsgetGet records by ID or filter.
Query (Vector)querySimilarity search by a query embedding vector.
Search (Text)searchFull-text / semantic search using query text, Chroma embeds it server-side via an attached function.
Update RecordsupdateUpdate existing records by ID (fails if an ID does not exist; use Upsert otherwise).
Upload & Index Documentupload_and_indexUpload a document file, chunk + embed it, and add the records.
Upsert RecordsupsertUpsert records, inserts new IDs and updates existing ones (idempotent sync).

Tenant

OperationIDDescription
Create Tenantcreate_tenantCreate a new tenant.
Get Tenantget_tenantGet metadata about a tenant.
Update Tenantupdate_tenantUpdate a tenant’s configuration.

Utility

OperationIDDescription
Get User Identityget_user_identityGet the identity of the currently authenticated user.
Get VersionversionGet the Chroma server version string.
HealthcheckhealthcheckCheck whether the Chroma server is healthy.
HeartbeatheartbeatGet the server heartbeat (nanosecond timestamp).
Reset ServerresetReset the Chroma server. DESTRUCTIVE, wipes ALL data across all tenants and databases.