Record management endpoints for adding, getting, updating, upserting, deleting, and querying records within a collection.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/chroma-records-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Chroma Records API
version: 2.0.0
contact:
name: Chroma Support
url: https://docs.trychroma.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
termsOfService: https://www.trychroma.com/terms
description: 'Operations tagged Records across 2 of this provider''s published API definitions: chroma-cloud-api-openapi.yml, chroma-server-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.trychroma.com
description: Chroma Cloud Production
- url: http://localhost:8000
description: Local Chroma Server
tags:
- name: Records
description: Record management endpoints for adding, getting, updating, upserting, deleting, and querying records within a collection.
paths:
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/count:
get:
operationId: countRecords
summary: Count records in a collection
description: Returns the number of records stored in the specified collection.
tags:
- Records
parameters:
- $ref: '#/components/parameters/tenantName'
- $ref: '#/components/parameters/databaseName'
- $ref: '#/components/parameters/collectionId'
responses:
'200':
description: Record count
content:
application/json:
schema:
type: integer
security:
- bearerAuth: []
servers:
- url: https://api.trychroma.com
description: Chroma Cloud Production
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/add:
post:
operationId: addRecords
summary: Add records to a collection
description: Adds new records to the specified collection. Supports batch operations of up to 100,000 or more items at once.
tags:
- Records
parameters:
- $ref: '#/components/parameters/tenantName'
- $ref: '#/components/parameters/databaseName'
- $ref: '#/components/parameters/collectionId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddRecordsRequest'
responses:
'201':
description: Records added successfully
'400':
description: Invalid request or duplicate IDs
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
servers:
- url: https://api.trychroma.com
description: Chroma Cloud Production
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/get:
post:
operationId: getRecords
summary: Get records from a collection
description: Retrieves records from the specified collection by their IDs or by a metadata filter.
tags:
- Records
parameters:
- $ref: '#/components/parameters/tenantName'
- $ref: '#/components/parameters/databaseName'
- $ref: '#/components/parameters/collectionId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetRecordsRequest'
responses:
'200':
description: Records retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/GetRecordsResponse'
security:
- bearerAuth: []
servers:
- url: https://api.trychroma.com
description: Chroma Cloud Production
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/update:
post:
operationId: updateRecords
summary: Update records in a collection
description: Updates existing records in the specified collection.
tags:
- Records
parameters:
- $ref: '#/components/parameters/tenantName'
- $ref: '#/components/parameters/databaseName'
- $ref: '#/components/parameters/collectionId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRecordsRequest'
responses:
'200':
description: Records updated successfully
'404':
description: Records not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
servers:
- url: https://api.trychroma.com
description: Chroma Cloud Production
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/upsert:
post:
operationId: upsertRecords
summary: Upsert records in a collection
description: Upserts records in the specified collection. If a record with the given ID already exists, it will be updated. If it does not exist, it will be created.
tags:
- Records
parameters:
- $ref: '#/components/parameters/tenantName'
- $ref: '#/components/parameters/databaseName'
- $ref: '#/components/parameters/collectionId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddRecordsRequest'
responses:
'200':
description: Records upserted successfully
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
servers:
- url: https://api.trychroma.com
description: Chroma Cloud Production
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/delete:
post:
operationId: deleteRecords
summary: Delete records from a collection
description: Deletes records from the specified collection by IDs or metadata filter.
tags:
- Records
parameters:
- $ref: '#/components/parameters/tenantName'
- $ref: '#/components/parameters/databaseName'
- $ref: '#/components/parameters/collectionId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRecordsRequest'
responses:
'200':
description: Records deleted successfully
content:
application/json:
schema:
type: array
items:
type: string
security:
- bearerAuth: []
servers:
- url: https://api.trychroma.com
description: Chroma Cloud Production
/api/v2/tenants/{tenantName}/databases/{databaseName}/collections/{collectionId}/query:
post:
operationId: queryRecords
summary: Query records in a collection
description: Performs a vector similarity search on the specified collection. Returns the nearest neighbors to the provided query embeddings or query texts.
tags:
- Records
parameters:
- $ref: '#/components/parameters/tenantName'
- $ref: '#/components/parameters/databaseName'
- $ref: '#/components/parameters/collectionId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryRecordsRequest'
responses:
'200':
description: Query results
content:
application/json:
schema:
$ref: '#/components/schemas/QueryRecordsResponse'
security:
- bearerAuth: []
servers:
- url: https://api.trychroma.com
description: Chroma Cloud Production
components:
schemas:
GetRecordsResponse:
type: object
properties:
ids:
type: array
items:
type: string
description: Record IDs
embeddings:
type: array
nullable: true
items:
type: array
items:
type: number
format: float
description: Embedding vectors if requested via include
documents:
type: array
nullable: true
items:
type: string
nullable: true
description: Documents if requested via include
metadatas:
type: array
nullable: true
items:
type: object
nullable: true
additionalProperties: true
description: Metadata objects if requested via include
uris:
type: array
nullable: true
items:
type: string
nullable: true
description: URIs if requested via include
required:
- ids
Error:
type: object
properties:
error:
type: string
description: Error message describing what went wrong
message:
type: string
description: Detailed error message
required:
- error
GetRecordsRequest:
type: object
properties:
ids:
type: array
nullable: true
items:
type: string
description: List of record IDs to retrieve
where:
$ref: '#/components/schemas/WhereFilter'
where_document:
$ref: '#/components/schemas/WhereDocumentFilter'
include:
type: array
items:
type: string
enum:
- embeddings
- documents
- metadatas
- uris
description: Fields to include in the response
limit:
type: integer
nullable: true
minimum: 1
description: Maximum number of records to return
offset:
type: integer
nullable: true
minimum: 0
description: Number of records to skip
AddRecordsRequest:
type: object
properties:
ids:
type: array
items:
type: string
description: Unique identifiers for each record
embeddings:
type: array
nullable: true
items:
type: array
items:
type: number
format: float
description: Vector embeddings for each record
documents:
type: array
nullable: true
items:
type: string
nullable: true
description: Text documents for each record
metadatas:
type: array
nullable: true
items:
type: object
nullable: true
additionalProperties: true
description: Metadata objects for each record
uris:
type: array
nullable: true
items:
type: string
nullable: true
description: URI references for each record
required:
- ids
QueryRecordsResponse:
type: object
properties:
ids:
type: array
items:
type: array
items:
type: string
description: Record IDs for each query result set
embeddings:
type: array
nullable: true
items:
type: array
items:
type: array
items:
type: number
format: float
description: Embedding vectors if requested via include
documents:
type: array
nullable: true
items:
type: array
items:
type: string
nullable: true
description: Documents if requested via include
metadatas:
type: array
nullable: true
items:
type: array
items:
type: object
nullable: true
additionalProperties: true
description: Metadata objects if requested via include
distances:
type: array
nullable: true
items:
type: array
items:
type: number
format: float
description: Distance scores if requested via include
uris:
type: array
nullable: true
items:
type: array
items:
type: string
nullable: true
description: URIs if requested via include
required:
- ids
WhereFilter:
type: object
nullable: true
additionalProperties: true
description: Metadata filter expression. Supports operators including $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin for field comparisons, and $and, $or for combining multiple conditions.
UpdateRecordsRequest:
type: object
properties:
ids:
type: array
items:
type: string
description: IDs of the records to update
embeddings:
type: array
nullable: true
items:
type: array
items:
type: number
format: float
description: Updated embedding vectors
documents:
type: array
nullable: true
items:
type: string
nullable: true
description: Updated documents
metadatas:
type: array
nullable: true
items:
type: object
nullable: true
additionalProperties: true
description: Updated metadata objects
uris:
type: array
nullable: true
items:
type: string
nullable: true
description: Updated URIs
required:
- ids
DeleteRecordsRequest:
type: object
properties:
ids:
type: array
nullable: true
items:
type: string
description: IDs of the records to delete
where:
$ref: '#/components/schemas/WhereFilter'
where_document:
$ref: '#/components/schemas/WhereDocumentFilter'
WhereDocumentFilter:
type: object
nullable: true
additionalProperties: true
description: Document content filter expression. Supports $contains and $not_contains operators for full-text search, and $regex and $not_regex operators for regular expression pattern matching.
QueryRecordsRequest:
type: object
properties:
query_embeddings:
type: array
nullable: true
items:
type: array
items:
type: number
format: float
description: Query embedding vectors to find nearest neighbors for
query_texts:
type: array
nullable: true
items:
type: string
description: Query texts to be embedded by the server
n_results:
type: integer
default: 10
minimum: 1
description: Number of nearest neighbor results to return per query
where:
$ref: '#/components/schemas/WhereFilter'
where_document:
$ref: '#/components/schemas/WhereDocumentFilter'
include:
type: array
items:
type: string
enum:
- embeddings
- documents
- metadatas
- distances
- uris
description: Fields to include in the response
GetRecordsRequest_2:
type: object
properties:
ids:
type: array
nullable: true
items:
type: string
description: List of record IDs to retrieve. At least one of ids or where must be provided.
where:
$ref: '#/components/schemas/WhereFilter'
where_document:
$ref: '#/components/schemas/WhereDocumentFilter'
include:
type: array
items:
type: string
enum:
- embeddings
- documents
- metadatas
- uris
description: Fields to include in the response. Defaults to metadatas and documents.
limit:
type: integer
nullable: true
minimum: 1
description: Maximum number of records to return
offset:
type: integer
nullable: true
minimum: 0
description: Number of records to skip
AddRecordsRequest_2:
type: object
properties:
ids:
type: array
items:
type: string
description: Unique identifiers for each record
embeddings:
type: array
nullable: true
items:
type: array
items:
type: number
format: float
description: Vector embeddings for each record. Each embedding is an array of floating point numbers.
documents:
type: array
nullable: true
items:
type: string
nullable: true
description: Text documents for each record. If provided without embeddings, the server will generate embeddings automatically.
metadatas:
type: array
nullable: true
items:
type: object
nullable: true
additionalProperties: true
description: Metadata objects for each record, stored as key-value pairs
uris:
type: array
nullable: true
items:
type: string
nullable: true
description: URI references for each record
required:
- ids
QueryRecordsRequest_2:
type: object
properties:
query_embeddings:
type: array
nullable: true
items:
type: array
items:
type: number
format: float
description: Query embedding vectors to find nearest neighbors for. Multiple queries can be performed in a single request.
query_texts:
type: array
nullable: true
items:
type: string
description: Query texts that will be embedded by the server before performing the similarity search.
n_results:
type: integer
default: 10
minimum: 1
description: Number of nearest neighbor results to return per query
where:
$ref: '#/components/schemas/WhereFilter'
where_document:
$ref: '#/components/schemas/WhereDocumentFilter'
include:
type: array
items:
type: string
enum:
- embeddings
- documents
- metadatas
- distances
- uris
description: Fields to include in the response. Defaults to metadatas, documents, and distances.
parameters:
tenantName:
name: tenantName
in: path
required: true
description: The name of the tenant
schema:
type: string
collectionId:
name: collectionId
in: path
required: true
description: The unique identifier of the collection
schema:
type: string
format: uuid
databaseName:
name: databaseName
in: path
required: true
description: The name of the database
schema:
type: string
tenantName_2:
name: tenantName
in: path
required: true
description: The name of the tenant
schema:
type: string
default: default_tenant
databaseName_2:
name: databaseName
in: path
required: true
description: The name of the database
schema:
type: string
default: default_database
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Bearer token authentication for Chroma Cloud. Obtain tokens from the Chroma Cloud dashboard.
tokenAuth:
type: apiKey
in: header
name: X-Chroma-Token
description: Static token authentication via the X-Chroma-Token header.
basicAuth:
type: http
scheme: basic
description: HTTP Basic authentication using RFC 7617 with a user:password base64-encoded Authorization header.
x-refined-from:
- chroma-cloud-api-openapi.yml
- chroma-server-api-openapi.yml