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 System API

System-level endpoints for health checks, version information, and server diagnostics.

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

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

This API exposes 5 operations across 5 paths. 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.

5 operations 5 paths 0 schemas 4 GET1 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 System 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 5

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

System 5

System-level endpoints for health checks, version information, and server diagnostics.

GET
/api/v2/heartbeat
Check server heartbeat
heartbeat → 200
GET
/api/v2/version
Get server version
getVersion → 200
GET
/api/v2/pre-flight-checks
Run pre-flight checks
preFlightChecks → 200
GET
/api/v2/healthcheck
Check server health
healthcheck → 200
POST
/api/v2/reset
Reset the server
reset → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chroma-system-api-openapi.yml Raw ↑

Other APIs Chroma publishes across the network.

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

This is an independent, third-party profile of Chroma System 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.