{
  "opencollection": "1.0.0",
  "info": {
    "name": "Chroma Cloud API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "System",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Check server heartbeat",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.trychroma.com/api/v2/heartbeat"
          },
          "docs": "Returns a heartbeat response indicating the server is alive and accepting requests."
        },
        {
          "info": {
            "name": "Get server version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.trychroma.com/api/v2/version"
          },
          "docs": "Returns the version string of the running Chroma Cloud server."
        }
      ]
    },
    {
      "info": {
        "name": "Tenants",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a tenant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new tenant in Chroma Cloud. Tenants are the top-level organizational unit and contain databases."
        },
        {
          "info": {
            "name": "Get a tenant",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              }
            ]
          },
          "docs": "Returns an existing tenant by name."
        }
      ]
    },
    {
      "info": {
        "name": "Databases",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List databases",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of items to skip before returning results"
              }
            ]
          },
          "docs": "Returns a list of all databases within the specified tenant."
        },
        {
          "info": {
            "name": "Create a database",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new database within the specified tenant."
        },
        {
          "info": {
            "name": "Get a database",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              }
            ]
          },
          "docs": "Returns an existing database by name within the specified tenant."
        },
        {
          "info": {
            "name": "Delete a database",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              }
            ]
          },
          "docs": "Deletes an existing database and all its collections."
        }
      ]
    },
    {
      "info": {
        "name": "Collections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of items to skip before returning results"
              }
            ]
          },
          "docs": "Returns a list of all collections within the specified database and tenant."
        },
        {
          "info": {
            "name": "Create a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new collection within the specified database and tenant."
        },
        {
          "info": {
            "name": "Get a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ]
          },
          "docs": "Returns an existing collection by its unique identifier."
        },
        {
          "info": {
            "name": "Update a collection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing collection's name or metadata."
        },
        {
          "info": {
            "name": "Delete a collection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ]
          },
          "docs": "Deletes an existing collection and all its records."
        }
      ]
    },
    {
      "info": {
        "name": "Records",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Count records in a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId/count",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ]
          },
          "docs": "Returns the number of records stored in the specified collection."
        },
        {
          "info": {
            "name": "Add records to a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId/add",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds new records to the specified collection. Supports batch operations of up to 100,000 or more items at once."
        },
        {
          "info": {
            "name": "Get records from a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId/get",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieves records from the specified collection by their IDs or by a metadata filter."
        },
        {
          "info": {
            "name": "Update records in a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId/update",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates existing records in the specified collection."
        },
        {
          "info": {
            "name": "Upsert records in a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId/upsert",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Delete records from a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId/delete",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes records from the specified collection by IDs or metadata filter."
        },
        {
          "info": {
            "name": "Query records in a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId/query",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs a vector similarity search on the specified collection. Returns the nearest neighbors to the provided query embeddings or query texts."
        }
      ]
    },
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search records in a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.trychroma.com/api/v2/tenants/:tenantName/databases/:databaseName/collections/:collectionId/search",
            "params": [
              {
                "name": "tenantName",
                "value": "",
                "type": "path",
                "description": "The name of the tenant"
              },
              {
                "name": "databaseName",
                "value": "",
                "type": "path",
                "description": "The name of the database"
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the collection"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs an advanced hybrid search on the specified collection. This endpoint is available exclusively in Chroma Cloud and provides a unified interface that replaces both query and get methods. Supports vector similarity search with Knn expressions, metadata filtering with composable Key expressions, full-text search, custom ranking expressions, and reciprocal rank fusion for combining multiple search strategies."
        }
      ]
    }
  ],
  "bundled": true
}