# Chroma Docs

- [Introduction](https://docs.trychroma.com/docs/overview/introduction.md): Chroma is the open-source data infrastructure for AI. It comes with everything you need to get started built-in.
- [Getting Started](https://docs.trychroma.com/docs/overview/getting-started.md): Chroma is the open-source data infrastructure for AI. It comes with everything you need to get started built-in, and runs on your machine.
- [Chroma Clients](https://docs.trychroma.com/docs/run-chroma/clients.md): Learn how to instantiate Chroma clients for Cloud, in-memory, and persistent use cases.
- [Client-Server Mode](https://docs.trychroma.com/docs/run-chroma/client-server.md): Learn how to run Chroma in client-server mode.
- [Manage Collections](https://docs.trychroma.com/docs/collections/manage-collections.md): Learn how to create, get, modify, and delete Chroma collections.
- [Adding Data to Chroma Collections](https://docs.trychroma.com/docs/collections/add-data.md): Learn how to add data to Chroma collections.
- [Update Data](https://docs.trychroma.com/docs/collections/update-data.md): Learn how to update and upsert data in Chroma collections.
- [Conditional Transactions](https://docs.trychroma.com/docs/collections/conditional-transactions.md): Use optimistic, collection-scoped transactions for read-check-write workflows.
- [Delete Data](https://docs.trychroma.com/docs/collections/delete-data.md): Learn how to delete data from Chroma collections.
- [Configure Collections](https://docs.trychroma.com/docs/collections/configure.md): Learn how to configure Chroma collection index settings and embedding functions.
- [Query and Get](https://docs.trychroma.com/docs/querying-collections/query-and-get.md): Learn how to query and retrieve data from Chroma collections.
- [Metadata Filtering](https://docs.trychroma.com/docs/querying-collections/metadata-filtering.md): Learn how to filter query results by metadata in Chroma collections.
- [Full Text Search](https://docs.trychroma.com/docs/querying-collections/full-text-search.md): Learn how to use full-text search and regex filtering in Chroma collections.
- [Embedding Functions](https://docs.trychroma.com/docs/embeddings/embedding-functions.md): Learn how to use embedding functions in Chroma to create vector representations of your data.
- [Multimodal Embeddings](https://docs.trychroma.com/docs/embeddings/multimodal.md): Learn how to work with multimodal data in Chroma collections.
- [Installing the CLI](https://docs.trychroma.com/docs/cli/install.md): Install the Chroma CLI to run a local server, browse collections, and interact with Chroma Cloud.
- [Run a Chroma Server](https://docs.trychroma.com/docs/cli/run.md): Run a Chroma server locally using the CLI.
- [Browse Collections](https://docs.trychroma.com/docs/cli/browse.md): Inspect your Chroma collections with an in-terminal UI.
- [Copy Collections](https://docs.trychroma.com/docs/cli/copy.md): Copy collections between local Chroma and Chroma Cloud.
- [DB Management](https://docs.trychroma.com/docs/cli/db.md): Manage your Chroma Cloud databases using the CLI.
- [Vacuum](https://docs.trychroma.com/docs/cli/vacuum.md): Shrink and optimize your Chroma database.
- [Login](https://docs.trychroma.com/docs/cli/login.md): Authenticate with Chroma Cloud using the CLI.
- [Profile Management](https://docs.trychroma.com/docs/cli/profile.md): Manage CLI profiles for Chroma Cloud authentication.
- [Sample Apps](https://docs.trychroma.com/docs/cli/sample-apps.md): Install and run Chroma sample applications.
- [Update](https://docs.trychroma.com/docs/cli/update.md): Check for CLI updates.
- [Open Source](https://docs.trychroma.com/docs/overview/oss.md): Chroma is the open-source data infrastructure for AI. Contribute to the project or learn about telemetry and privacy.
- [Migration](https://docs.trychroma.com/docs/overview/migration.md): Migration guides for Chroma version upgrades and schema changes.
- [Troubleshooting](https://docs.trychroma.com/docs/overview/troubleshooting.md): Common issues and solutions when working with Chroma.
- [Chroma Cloud](https://docs.trychroma.com/cloud/getting-started.md)
- [Pricing](https://docs.trychroma.com/cloud/pricing.md)
- [Quotas & Limits](https://docs.trychroma.com/cloud/quotas-limits.md)
- [Collection Forking](https://docs.trychroma.com/cloud/features/collection-forking.md): Instant copy-on-write collection forking in Chroma Cloud.
- [Schema Overview](https://docs.trychroma.com/cloud/schema/overview.md)
- [Schema Basics](https://docs.trychroma.com/cloud/schema/schema-basics.md): Learn how to create and use Schema to configure indexes on your Chroma collections.
- [Sparse Vector Search Setup](https://docs.trychroma.com/cloud/schema/sparse-vector-search.md): Learn how to configure and use sparse vectors for keyword-based search, and combine them with dense embeddings for powerful hybrid search capabilities.
- [Index Configuration Reference](https://docs.trychroma.com/cloud/schema/index-reference.md): Comprehensive reference for all index types and their configuration parameters.
- [Search API Overview](https://docs.trychroma.com/cloud/search-api/overview.md)
- [Search Basics](https://docs.trychroma.com/cloud/search-api/search-basics.md): Learn how to construct and use the Search class for querying your Chroma collections.
- [Filtering with Where](https://docs.trychroma.com/cloud/search-api/filtering.md): Learn how to filter search results using Where expressions and the Key/K class to narrow down your search to specific documents, IDs, or metadata values.
- [Ranking and Scoring](https://docs.trychroma.com/cloud/search-api/ranking.md): Learn how to use ranking expressions to score and order your search results. In Chroma, lower scores indicate better matches (distance-based scoring).
- [Group By & Aggregation](https://docs.trychroma.com/cloud/search-api/group-by.md): Learn how to group search results by metadata keys and select the top results from each group. GroupBy is useful for diversifying results, deduplication, and category-aware ranking.
- [Hybrid Search with RRF](https://docs.trychroma.com/cloud/search-api/hybrid-search.md): Learn how to combine multiple ranking strategies using Reciprocal Rank Fusion (RRF). RRF is ideal for hybrid search scenarios where you want to merge results from different ranking methods (e.g., dense and sparse embeddings).
- [Pagination & Field Selection](https://docs.trychroma.com/cloud/search-api/pagination-selection.md): Control how many results to return and which fields to include in your search results.
- [Batch Operations](https://docs.trychroma.com/cloud/search-api/batch-operations.md): Execute multiple searches in a single API call for better performance and easier comparison of results.
- [Examples & Patterns](https://docs.trychroma.com/cloud/search-api/examples.md): Complete end-to-end examples demonstrating real-world use cases of the Search API.
- [Migration Guide](https://docs.trychroma.com/cloud/search-api/migration.md): Migrate from legacy `query()` and `get()` to the Search API.
- [Overview](https://docs.trychroma.com/cloud/sync/overview.md)
- [S3 Sync](https://docs.trychroma.com/cloud/sync/s3.md): Sync files from Amazon S3 into Chroma Cloud.
- [GitHub](https://docs.trychroma.com/cloud/sync/github.md): Sync GitHub repositories into Chroma Cloud.
- [Web Sync](https://docs.trychroma.com/cloud/sync/web.md): Crawl and sync website content into Chroma Cloud.
- [File Upload](https://docs.trychroma.com/cloud/sync/file-upload.md): Upload individual files directly to Chroma Cloud.
- [Package Search MCP Server](https://docs.trychroma.com/cloud/package-search/mcp.md)
- [Package Search Registry](https://docs.trychroma.com/cloud/package-search/registry.md)
- [Building with AI](https://docs.trychroma.com/guides/build/building-with-ai.md): Use LLMs to process unstructured data in your applications.
- [Intro to Retrieval](https://docs.trychroma.com/guides/build/intro-to-retrieval.md): Ground LLMs in your own data using retrieval-augmented generation.
- [Look at Your Data](https://docs.trychroma.com/guides/build/look-at-your-data.md): Design your collection schema and chunking strategy based on your data.
- [Chunking](https://docs.trychroma.com/guides/build/chunking.md)
- [Agentic Search](https://docs.trychroma.com/guides/build/agentic-search.md): Build agents that iteratively search and refine results to answer complex queries.
- [Agentic Memory](https://docs.trychroma.com/guides/build/agentic-memory.md): Persist agent context across runs for better performance and personalization.
- [Running Chroma in Client-Server Mode](https://docs.trychroma.com/guides/deploy/client-server-mode.md)
- [Chroma's Thin-Client](https://docs.trychroma.com/guides/deploy/python-thin-client.md)
- [Observability](https://docs.trychroma.com/guides/deploy/observability.md): Monitor and trace your Chroma deployment with OpenTelemetry.
- [Docker](https://docs.trychroma.com/guides/deploy/docker.md): Run Chroma in a Docker Container
- [AWS](https://docs.trychroma.com/guides/deploy/aws.md): Deploy Chroma on AWS using CloudFormation.
- [Azure](https://docs.trychroma.com/guides/deploy/azure.md): Deploy Chroma on Azure using Terraform.
- [GCP](https://docs.trychroma.com/guides/deploy/gcp.md): Deploy Chroma on Google Cloud Platform using Terraform.
- [General](https://docs.trychroma.com/guides/performance/general.md): How to improve Chroma performance across single-node and distributed deployments.
- [Single-Node Performance](https://docs.trychroma.com/guides/performance/single-node.md): Single-node Chroma performance benchmarks and limitations.
- [Distributed/Cloud Performance](https://docs.trychroma.com/guides/performance/distributed.md): How to think about performance in distributed Chroma deployments.
- [Integrations](https://docs.trychroma.com/integrations/chroma-integrations.md)
- [OpenAI](https://docs.trychroma.com/integrations/embedding-models/openai.md)
- [Cohere](https://docs.trychroma.com/integrations/embedding-models/cohere.md)
- [Google Gemini](https://docs.trychroma.com/integrations/embedding-models/google-gemini.md)
- [Hugging Face](https://docs.trychroma.com/integrations/embedding-models/hugging-face.md)
- [Hugging Face Server](https://docs.trychroma.com/integrations/embedding-models/hugging-face-server.md)
- [Instructor](https://docs.trychroma.com/integrations/embedding-models/instructor.md)
- [Jina AI](https://docs.trychroma.com/integrations/embedding-models/jina-ai.md)
- [Mistral](https://docs.trychroma.com/integrations/embedding-models/mistral.md)
- [Morph](https://docs.trychroma.com/integrations/embedding-models/morph.md)
- [Nomic](https://docs.trychroma.com/integrations/embedding-models/nomic.md)
- [Ollama](https://docs.trychroma.com/integrations/embedding-models/ollama.md)
- [OpenCLIP](https://docs.trychroma.com/integrations/embedding-models/open-clip.md)
- [Perplexity](https://docs.trychroma.com/integrations/embedding-models/perplexity.md)
- [Roboflow](https://docs.trychroma.com/integrations/embedding-models/roboflow.md)
- [Sentence Transformer](https://docs.trychroma.com/integrations/embedding-models/sentence-transformer.md)
- [Text2Vec](https://docs.trychroma.com/integrations/embedding-models/text2vec.md)
- [Together AI](https://docs.trychroma.com/integrations/embedding-models/together-ai.md)
- [VoyageAI](https://docs.trychroma.com/integrations/embedding-models/voyageai.md)
- [Cloudflare Workers AI](https://docs.trychroma.com/integrations/embedding-models/cloudflare-workers-ai.md)
- [Amazon Bedrock](https://docs.trychroma.com/integrations/embedding-models/amazon-bedrock.md)
- [Baseten](https://docs.trychroma.com/integrations/embedding-models/baseten.md)
- [Chroma Cloud Qwen](https://docs.trychroma.com/integrations/embedding-models/chroma-cloud-qwen.md)
- [Superlinked](https://docs.trychroma.com/integrations/embedding-models/superlinked.md)
- [Chroma BM25](https://docs.trychroma.com/integrations/embedding-models/chroma-bm25.md)
- [Chroma Cloud Splade](https://docs.trychroma.com/integrations/embedding-models/chroma-cloud-splade.md)
- [Hugging Face](https://docs.trychroma.com/integrations/embedding-models/hugging-face.md)
- [Superlinked](https://docs.trychroma.com/integrations/embedding-models/superlinked.md)
- [Anthropic MCP](https://docs.trychroma.com/integrations/frameworks/anthropic-mcp.md)
- [Google ADK](https://docs.trychroma.com/integrations/frameworks/google-adk.md)
- [Braintrust](https://docs.trychroma.com/integrations/frameworks/braintrust.md)
- [Contextual AI](https://docs.trychroma.com/integrations/frameworks/contextual-ai.md)
- [DeepEval](https://docs.trychroma.com/integrations/frameworks/deepeval.md)
- [Haystack](https://docs.trychroma.com/integrations/frameworks/haystack.md)
- [Langchain](https://docs.trychroma.com/integrations/frameworks/langchain.md)
- [LlamaIndex](https://docs.trychroma.com/integrations/frameworks/llamaindex.md)
- [Mem0](https://docs.trychroma.com/integrations/frameworks/mem0.md)
- [OpenLIT](https://docs.trychroma.com/integrations/frameworks/openlit.md)
- [OpenLLMetry](https://docs.trychroma.com/integrations/frameworks/openllmetry.md)
- [Streamlit](https://docs.trychroma.com/integrations/frameworks/streamlit.md)
- [VoltAgent](https://docs.trychroma.com/integrations/frameworks/voltagent.md)
- [Overview](https://docs.trychroma.com/reference/overview.md)
- [Chroma Configuration](https://docs.trychroma.com/reference/server-env-vars.md): Environment variables when self-hosting a Chroma server.
- [Client](https://docs.trychroma.com/reference/python/client.md)
- [Collection](https://docs.trychroma.com/reference/python/collection.md)
- [Embedding Functions](https://docs.trychroma.com/reference/python/embedding-functions.md)
- [Search](https://docs.trychroma.com/reference/python/search.md)
- [Schema](https://docs.trychroma.com/reference/python/schema.md)
- [Where Filters](https://docs.trychroma.com/reference/python/where-filter.md): Reference for the Python DSL used to build where filters.
- [Client](https://docs.trychroma.com/reference/typescript/client.md)
- [Collection](https://docs.trychroma.com/reference/typescript/collection.md)
- [Embedding Functions](https://docs.trychroma.com/reference/typescript/embedding-functions.md)
- [Search](https://docs.trychroma.com/reference/typescript/search.md)
- [Schema](https://docs.trychroma.com/reference/typescript/schema.md)
- [Where Filters](https://docs.trychroma.com/reference/typescript/where-filter.md): Reference for the TypeScript DSL used to build where filters.
- [Rust](https://docs.trychroma.com/reference/rust.md)
- [Kotlin](https://docs.trychroma.com/reference/kotlin.md)
- [Swift](https://docs.trychroma.com/reference/swift.md)
- [Create tenant](https://docs.trychroma.com/reference/chroma-api/tenant/create-tenant.md): Creates a new tenant.
- [Get tenant](https://docs.trychroma.com/reference/chroma-api/tenant/get-tenant.md): Returns an existing tenant by name.
- [Update tenant](https://docs.trychroma.com/reference/chroma-api/tenant/update-tenant.md): Updates an existing tenant by name.
- [List databases](https://docs.trychroma.com/reference/chroma-api/database/list-databases.md): Lists all databases for a tenant.
- [Create database](https://docs.trychroma.com/reference/chroma-api/database/create-database.md): Creates a new database for a tenant.
- [Get database](https://docs.trychroma.com/reference/chroma-api/database/get-database.md): Returns a database by name.
- [Delete database](https://docs.trychroma.com/reference/chroma-api/database/delete-database.md): Deletes a database by name.
- [List collections](https://docs.trychroma.com/reference/chroma-api/collection/list-collections.md): Lists all collections in a database.
- [Get number of collections](https://docs.trychroma.com/reference/chroma-api/collection/get-number-of-collections.md): Returns the total number of collections in a database.
- [Create collection](https://docs.trychroma.com/reference/chroma-api/collection/create-collection.md): Creates a new collection in a database.
- [Get collection](https://docs.trychroma.com/reference/chroma-api/collection/get-collection.md): Returns a collection by ID or name.
- [Update collection](https://docs.trychroma.com/reference/chroma-api/collection/update-collection.md): Updates an existing collection's name or metadata.
- [Delete collection](https://docs.trychroma.com/reference/chroma-api/collection/delete-collection.md): Deletes a collection in a database.
- [Add records](https://docs.trychroma.com/reference/chroma-api/record/add-records.md): Adds records to a collection.
- [Get number of records](https://docs.trychroma.com/reference/chroma-api/record/get-number-of-records.md): Returns the number of records in a collection.
- [Delete records](https://docs.trychroma.com/reference/chroma-api/record/delete-records.md): Deletes records in a collection. Can filter by IDs or metadata.
- [Get indexing status](https://docs.trychroma.com/reference/chroma-api/record/get-indexing-status.md): Returns the indexing status of a collection.
- [Get records](https://docs.trychroma.com/reference/chroma-api/record/get-records.md): Returns records from a collection by ID or metadata filter.
- [Query collection](https://docs.trychroma.com/reference/chroma-api/record/query-collection.md): Queries a collection using dense vector search with metadata and full-text search filtering.
- [Search records](https://docs.trychroma.com/reference/chroma-api/record/search-records.md): Searches records from a collection with dense, sparse, or hybrid vector search.
- [Update records](https://docs.trychroma.com/reference/chroma-api/record/update-records.md): Updates records in a collection by ID.
- [Upsert records](https://docs.trychroma.com/reference/chroma-api/record/upsert-records.md): Upserts records in a collection (create if not exists, otherwise update).
- [Healthcheck](https://docs.trychroma.com/reference/chroma-api/system/healthcheck.md): Returns the health status of the service.
- [Heartbeat](https://docs.trychroma.com/reference/chroma-api/system/heartbeat.md): Returns a nanosecond timestamp of the current time.
- [Pre-flight checks](https://docs.trychroma.com/reference/chroma-api/system/pre-flight-checks.md): Returns basic readiness information.
- [Get version](https://docs.trychroma.com/reference/chroma-api/system/get-version.md): Returns the version of the server.
- [Get user identity](https://docs.trychroma.com/reference/chroma-api/authentication/get-user-identity.md): Returns the current user's identity, tenant, and databases.
- [Fork collection](https://docs.trychroma.com/api-reference/collection/fork-collection.md): Creates a fork of an existing collection.
- [Attach function](https://docs.trychroma.com/api-reference/function/attach-function.md): Attaches a function to a collection.
- [Get attached function](https://docs.trychroma.com/api-reference/function/get-attached-function.md): Returns an attached function by name.
- [Detach function](https://docs.trychroma.com/api-reference/function/detach-function.md): Detaches a function from a collection.
- [List invocations](https://docs.trychroma.com/reference/sync-api/invocation/list-invocations.md): Lists invocations for a source or database.
- [Get invocation](https://docs.trychroma.com/reference/sync-api/invocation/get-invocation.md): Returns details of an invocation with the provided ID.
- [Cancel invocation](https://docs.trychroma.com/reference/sync-api/invocation/cancel-invocation.md): Cancels an invocation.
- [Create invocation](https://docs.trychroma.com/reference/sync-api/invocation/create-invocation.md): Creates a new invocation for a source.
- [Get latest invocations by keys](https://docs.trychroma.com/reference/sync-api/invocation/get-latest-invocations-by-keys.md): Returns the latest invocations for the given keys on a source.
- [List sources](https://docs.trychroma.com/reference/sync-api/source/list-sources.md): Lists sources owned by a tenant.
- [Create source](https://docs.trychroma.com/reference/sync-api/source/create-source.md): Creates a new sync source.
- [Get source](https://docs.trychroma.com/reference/sync-api/source/get-source.md): Returns details of a source with the provided ID.
- [Delete source](https://docs.trychroma.com/reference/sync-api/source/delete-source.md): Deletes a source with the provided ID.
- [Get service health status](https://docs.trychroma.com/reference/sync-api/system/get-service-health-status.md): Returns the health status of the sync service.
- [Upload and index a file](https://docs.trychroma.com/reference/sync-api/file-upload/upload-and-index-a-file.md): Uploads a file and creates an invocation to index it into the specified collection.
- [Generate dense embeddings](https://docs.trychroma.com/reference/embeddings-api/generate-dense-embeddings.md): Generate dense vector embeddings for the given texts using the specified model. Provide either 'instructions' or both 'task' and 'target' alongside 'texts'.
- [Generate sparse embeddings](https://docs.trychroma.com/reference/embeddings-api/generate-sparse-embeddings.md): Generate sparse vector embeddings for the given texts using the specified model. Provide either 'instructions' or both 'task' and 'target' alongside 'texts'. Set 'fetch_labels' to true to include token labels in the response.
- [Search](https://docs.trychroma.com/reference/search.md): Reference guide for Search dictionary syntax used in Chroma.
- [Where Filters](https://docs.trychroma.com/reference/where-filter.md): Reference guide for where filter JSON syntax used in Chroma queries and searches.
- [Architecture Overview](https://docs.trychroma.com/reference/architecture/overview.md): How Chroma is structured across local, single-node, and distributed deployments.
- [Distributed Architecture](https://docs.trychroma.com/reference/architecture/distributed.md): How Chroma scales out with independent services, object storage, SSD caches, and a shared system database.

## OpenAPI Specs

- [openapi](https://api.trychroma.com/openapi.json)
- [openapi](https://embed.trychroma.com/openapi.json)
- [sync.openapi](/sync.openapi.json)