canonical: https://jentic.com/apis/trychroma.com/trychroma

# Trychroma Chroma Cloud REST API

Chroma is an open-source AI-native vector database. The REST API provides endpoints for managing databases, tenants, collections, and performing vector operations like add, query, update, and delete embeddings. The API exposes 20 endpoints secured with bearer authentication.

## For AI agents

Programmatically server heartbeat, get server version. Covers 20 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for ai and machine learning only.

## Capabilities

- Server heartbeat
- Get server version
- Pre-flight checks
- Create a tenant
- Monitor Chroma Cloud REST API operational status and events

## Use cases

### AI and Machine Learning Operations

Use the Chroma Cloud REST API to perform ai ml operations programmatically. The API provides 20 endpoints covering core functionality including server heartbeat, get server version, pre-flight checks.

Example prompt: Call GET /api/v2/heartbeat to server heartbeat

### Automated Server Management

Automate server operations by combining multiple Chroma Cloud REST API endpoints. Agents can get server version and then pre-flight checks in a single workflow.

Example prompt: Call GET /api/v2/version to get server version, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Chroma Cloud REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'server heartbeat', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/v2/heartbeat | Server heartbeat |
| GET | /api/v2/version | Get server version |
| GET | /api/v2/pre-flight-checks | Pre-flight checks |
| GET | /api/v2/tenants/{tenant} | Get a tenant |
| POST | /api/v2/tenants | Create a tenant |
| GET | /api/v2/tenants/{tenant}/databases/{database} | Get a database |
| POST | /api/v2/tenants/{tenant}/databases | Create a database |
| POST | /api/v2/tenants/{tenant}/databases/{database}/collections | Create a collection |

## Key resources

- **Server** — Server health and version
- **Tenants** — Manage tenants
- **Databases** — Manage databases
- **Collections** — Manage collections
- **Records** — Add, update, query, delete embeddings

## Why Jentic

- **Setup:** Wiring Chroma Cloud REST API by hand means learning its bearer auth, pointing at its host on port 8000, and threading tenant and database context through every call with your own error handling and retries. Through Jentic you install once, import Chroma Cloud REST API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Chroma Cloud REST API puts the tenant and database in the URL path (/api/v2/tenants/{tenant}/databases/{database}/...), so a rule can pin your agent to one database: it can list and create collections there and nothing else. You choose the operations it may call, so creating new tenants or databases are not included unless you add them.
- **Credential handling:** Your Chroma Cloud REST API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a collection' or 'check the server heartbeat', and Jentic returns the matching Chroma Cloud REST API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Openai** — Alternative ai ml API
- **Anthropic** — Alternative ai ml API
- **Cohere** — Complementary ai ml API
- **Huggingface** — Complementary ai ml API

## FAQ

### What authentication does the Chroma Cloud REST API use?

The Chroma Cloud REST API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I server heartbeat with the Chroma Cloud REST API?

Yes. Use the GET /api/v2/heartbeat endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Chroma Cloud REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I server heartbeat through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'server heartbeat'. Jentic returns the matching Chroma Cloud REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Chroma Cloud REST API have?

The Chroma Cloud REST API exposes 20 endpoints covering server, tenants, databases operations.

### Can I limit what my agent is allowed to do with the Chroma Cloud REST API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which Chroma operations and credentials your agent may use. Since the Chroma Cloud REST API carries the tenant and database in the URL path (/api/v2/tenants/{tenant}/databases/{database}/...), you can pin the agent to a single database so it only lists and creates collections there. You also choose the specific operations it may call, so creating new tenants or databases stays off-limits unless you explicitly allow it.