Skip to content

Update docs for Chroma Cloud #710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 11, 2025
Merged

Update docs for Chroma Cloud #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a26786
Update docs for Chroma Cloud
kylediaz Aug 7, 2025
cc50835
Apply suggestions from code review
Paul-Cornell Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions snippets/general-shared-text/chroma-cli-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-d

The following environment variables:

- `CHROMA_HOST` - The , represented by `--host` (CLI) or `host` (Python).
- `CHROMA_PORT` - The , represented by `--port` (CLI) or `port` (Python).
- `CHROMA_HOST` - The , represented by `--host` (CLI) or `host` (Python). Chroma Cloud uses `api.trychroma.com`.
- `CHROMA_PORT` - The , represented by `--port` (CLI) or `port` (Python). Chroma Cloud uses port `8000`.
- `CHROMA_TENANT` - The name of the tenant that you want to access on the Chroma server, represented by `--tenant` (CLI) or `tenant` (Python).
- `CHROMA_DATABASE` - The name of the database that you want to access in the tenant, represented by `--database` (CLI) or `database` (Python).
- `CHROMA_COLLECTION` - The name of the collection that you want to access in the database, represented by `--collection-name` (CLI) or `collection_name` (Python).
Expand All @@ -22,3 +22,11 @@ Additional settings include:
- `--settings` (CLI) or `settings` (Python): A dictionary of settings to communicate with the Chroma server, for example: `'{"persist_directory":"./chroma-persist"}'`.
- `--headers` (CLI) or `headers` (Python): A dictionary of headers to send to the Chroma server, for example: `'{"Authorization":"Basic()"}'`.
- `--ssl` (CLI) or `ssl` (Python): True to use SSL for the connection.

In order to use Chroma Cloud, you should have this configuration:

- `host=api.trychroma.com`
- `port=8000`
- Get your `tenant` id from the [Chroma dashboard](https://trychroma.com)
- `headers={'x-chroma-token': 'YOUR_API_KEY'}`
- `ssl` should be enabled.
19 changes: 3 additions & 16 deletions snippets/general-shared-text/chroma.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,6 @@
- A Chroma server. See [Deployment](https://docs.trychroma.com/deployment).

For example, here is a video about how to deploy a Chroma server to AWS:

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/4ApW6ZwqW20"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

- The Chroma server's hostname or IP address, and the server's port number.
- If you are not connecting to the server through HTTP, the path to the server instance.
- A Chroma server. You can connect to a [hosted Chroma Cloud server](https://trychroma.com/signup) or [deploy your own server](https://docs.trychroma.com/deployment).
- The Chroma server's hostname or IP address, and the server's port number. For Chroma Cloud, the host is `api.trychroma.com`, and the port number is `8000`.
- If you are using local Chroma, the [path to the folder where you store your database](https://docs.trychroma.com/docs/run-chroma/persistent-client).
- The name of the tenant that you want to access on the server.
- The name of the database that you want to access in the tenant.
- The name of the collection that you want to access in the database.