{"openapi":"3.1.0","info":{"title":"Chroma Cloud (BYOK) API","version":"0.1.0","description":"Chroma Cloud (BYOK) lets an AI assistant read your own Chroma Cloud data through the Chroma Cloud API with a key you supply (Chroma Cloud API key). Read-only: 10 tools (get_user_identity, get_tenant, list_databases, get_database, list_collections, get_collection, count_collections, count_records, get_indexing_status, get_record). The BYOK key travels with each request, is used for that one call...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-chroma.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-chroma/docs"},"termsOfService":"https://connectorbay.com/byok-chroma/terms"},"servers":[{"url":"https://byok-chroma.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-chroma/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_user_identity":{"post":{"operationId":"get_user_identity","summary":"Show the identity of the key: user id, tenant name and the databases it can reach. Use for \"Which Chroma Cloud tenant an","description":"Show the identity of the key: user id, tenant name and the databases it can reach. Use for \"Which Chroma Cloud tenant and databases does my key belong to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_user_identityArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_tenant":{"post":{"operationId":"get_tenant","summary":"Get one Chroma tenant by name. Use for \"Show my Chroma tenant my-tenant\".","description":"Get one Chroma tenant by name. Use for \"Show my Chroma tenant my-tenant\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant_name":{"description":"Tenant name.","maxLength":100,"title":"Tenant Name","type":"string"}},"required":["tenant_name"],"title":"get_tenantArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_databases":{"post":{"operationId":"list_databases","summary":"List the databases of a tenant with id and name. Use for \"Which databases are in my Chroma tenant\".","description":"List the databases of a tenant with id and name. Use for \"Which databases are in my Chroma tenant\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Chroma Cloud tenant name or id (get_user_identity shows it).","maxLength":100,"title":"Tenant","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return.","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip (for paging).","title":"Offset"}},"required":["tenant"],"title":"list_databasesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_database":{"post":{"operationId":"get_database","summary":"Get one Chroma database by name: id, name and tenant. Use for \"Show my Chroma database my-database\".","description":"Get one Chroma database by name: id, name and tenant. Use for \"Show my Chroma database my-database\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Chroma Cloud tenant name or id (get_user_identity shows it).","maxLength":100,"title":"Tenant","type":"string"},"database":{"description":"Database name inside the tenant.","maxLength":100,"title":"Database","type":"string"}},"required":["tenant","database"],"title":"get_databaseArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_collections":{"post":{"operationId":"list_collections","summary":"List the collections of a database with id, name, dimension, metadata and version. Use for \"What collections are in my C","description":"List the collections of a database with id, name, dimension, metadata and version. Use for \"What collections are in my Chroma database\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Chroma Cloud tenant name or id (get_user_identity shows it).","maxLength":100,"title":"Tenant","type":"string"},"database":{"description":"Database name inside the tenant.","maxLength":100,"title":"Database","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return.","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip (for paging).","title":"Offset"}},"required":["tenant","database"],"title":"list_collectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_collection":{"post":{"operationId":"get_collection","summary":"Get one collection by id: name, dimension, metadata, log position and version. Use for \"Show Chroma collection 3f2504e0-","description":"Get one collection by id: name, dimension, metadata, log position and version. Use for \"Show Chroma collection 3f2504e0-4f89-41d3-9a0c-0305e82c3301\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Chroma Cloud tenant name or id (get_user_identity shows it).","maxLength":100,"title":"Tenant","type":"string"},"database":{"description":"Database name inside the tenant.","maxLength":100,"title":"Database","type":"string"},"collection_id":{"description":"Collection id (a UUID, from list_collections).","maxLength":60,"title":"Collection Id","type":"string"}},"required":["tenant","database","collection_id"],"title":"get_collectionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/count_collections":{"post":{"operationId":"count_collections","summary":"Count the collections in a database. The answer is a single number. Use for \"How many collections does my Chroma databas","description":"Count the collections in a database. The answer is a single number. Use for \"How many collections does my Chroma database have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Chroma Cloud tenant name or id (get_user_identity shows it).","maxLength":100,"title":"Tenant","type":"string"},"database":{"description":"Database name inside the tenant.","maxLength":100,"title":"Database","type":"string"}},"required":["tenant","database"],"title":"count_collectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/count_records":{"post":{"operationId":"count_records","summary":"Count the records in a collection. The answer is a single number. Use for \"How many records are in my Chroma collection\"","description":"Count the records in a collection. The answer is a single number. Use for \"How many records are in my Chroma collection\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Chroma Cloud tenant name or id (get_user_identity shows it).","maxLength":100,"title":"Tenant","type":"string"},"database":{"description":"Database name inside the tenant.","maxLength":100,"title":"Database","type":"string"},"collection_id":{"description":"Collection id (a UUID, from list_collections).","maxLength":60,"title":"Collection Id","type":"string"},"read_level":{"anyOf":[{"enum":["index_and_wal","index_only","index_and_bounded_wal"],"type":"string"},{"type":"null"}],"default":null,"description":"Consistency: index_and_wal (all writes, default), index_only, or index_and_bounded_wal.","title":"Read Level"}},"required":["tenant","database","collection_id"],"title":"count_recordsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_indexing_status":{"post":{"operationId":"get_indexing_status","summary":"Show how many operations of a collection are indexed or still waiting, with progress. Use for \"Is my Chroma collection f","description":"Show how many operations of a collection are indexed or still waiting, with progress. Use for \"Is my Chroma collection fully indexed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Chroma Cloud tenant name or id (get_user_identity shows it).","maxLength":100,"title":"Tenant","type":"string"},"database":{"description":"Database name inside the tenant.","maxLength":100,"title":"Database","type":"string"},"collection_id":{"description":"Collection id (a UUID, from list_collections).","maxLength":60,"title":"Collection Id","type":"string"}},"required":["tenant","database","collection_id"],"title":"get_indexing_statusArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_record":{"post":{"operationId":"get_record","summary":"Get one record of a collection by its id: the stored document text and metadata (embeddings are not returned). Use for \"","description":"Get one record of a collection by its id: the stored document text and metadata (embeddings are not returned). Use for \"Show record doc-1 of my Chroma collection\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Chroma Cloud tenant name or id (get_user_identity shows it).","maxLength":100,"title":"Tenant","type":"string"},"database":{"description":"Database name inside the tenant.","maxLength":100,"title":"Database","type":"string"},"collection_id":{"description":"Collection id (a UUID, from list_collections).","maxLength":60,"title":"Collection Id","type":"string"},"record_id":{"description":"Id of the record inside the collection.","maxLength":200,"title":"Record Id","type":"string"}},"required":["tenant","database","collection_id","record_id"],"title":"get_recordArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}