How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chroma Records API

Record management endpoints for adding, getting, updating, upserting, deleting, and querying records within a collection.

Chroma Records API is one of 9 APIs that Chroma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Records. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against 2 base URLs: https://api.trychroma.com, http://localhost:8000.

7 operations 7 paths 13 schemas 1 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.trychroma.com
Authentication
HTTP Bearer, API Key, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 3

Chroma Records API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Chroma-Token (tokenAuth). It accepts HTTP basic authentication (basicAuth).

  • bearerAuth — Bearer token authentication for Chroma Cloud. Obtain tokens from the Chroma Cloud dashboard.
  • tokenAuth — Static token authentication via the X-Chroma-Token header.
  • basicAuth — HTTP Basic authentication using RFC 7617 with a user:password base64-encoded Authorization header.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 1 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Records 7

Record management endpoints for adding, getting, updating, upserting, deleting, and querying records within a collection.

GET
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/count
Count records in a collection
countRecords 3 params → 200
POST
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/add
Add records to a collection
addRecords 3 params body → 201400
POST
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/get
Get records from a collection
getRecords 3 params body → 200
POST
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/update
Update records in a collection
updateRecords 3 params body → 200404
POST
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/upsert
Upsert records in a collection
upsertRecords 3 params body → 200400
POST
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/delete
Delete records from a collection
deleteRecords 3 params body → 200
POST
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/query
Query records in a collection
queryRecords 3 params body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are QueryRecordsResponse (6 properties), QueryRecordsRequest_2 (6 properties), GetRecordsRequest_2 (6 properties), QueryRecordsRequest (6 properties). Each schema is shown below with its type and property counts.

GetRecordsResponse
object
5 properties 1 required
Error
object
2 properties 1 required
GetRecordsRequest
object
6 properties
AddRecordsRequest
object
5 properties 1 required
QueryRecordsResponse
object
6 properties 1 required
WhereFilter
object
Metadata filter expression. Supports operators including $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin for field comparisons, and $and, $or for combining multiple…
UpdateRecordsRequest
object
5 properties 1 required
DeleteRecordsRequest
object
3 properties
WhereDocumentFilter
object
Document content filter expression. Supports $contains and $notcontains operators for full-text search, and $regex and $notregex operators for regular expressi…
QueryRecordsRequest
object
6 properties
GetRecordsRequest_2
object
6 properties
AddRecordsRequest_2
object
5 properties 1 required
QueryRecordsRequest_2
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chroma-records-api-openapi.yml Raw ↑

Other APIs Chroma publishes across the network.

Chroma Python Client
Chroma JavaScript Client
Chroma Collections API
Chroma Databases API
Chroma Search API
Chroma System API
Chroma Tenants API
Chroma Query API
Where this information came from

This is an independent, third-party profile of Chroma Records API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.