Typesense · Schema

ClusterCreateSchema

Full-Text SearchOpen SourceSearch EngineTypo ToleranceVector Search

Properties

Name	Type	Description
memory	string	Memory allocation for the cluster, such as 0.5_gb, 1_gb, 2_gb, 4_gb, 8_gb, 16_gb, 32_gb, 64_gb, 96_gb, 128_gb, 192_gb, 256_gb, or 384_gb.
vcpu	string	vCPU configuration for the cluster, such as 2_vcpus_2_hr_burst_per_day or dedicated vCPU options.
gpu	boolean	Whether to provision a GPU-enabled cluster for embedding generation.
high_performance_disk	string	High-performance disk configuration.
typesense_server_version	string	Typesense Server version to deploy on the cluster.
high_availability	string	Whether to enable high availability with 3-node replication.
search_delivery_network	string	Whether to enable search delivery network for global distribution.
load_balancing	string	Whether to enable load balancing.
regions	array	Cloud regions to deploy the cluster in.
cluster_name	string	Optional friendly name for the cluster.
auto_upgrade_capacity	boolean	Whether to automatically upgrade cluster capacity when needed.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClusterCreateSchema",
  "title": "ClusterCreateSchema",
  "type": "object",
  "required": [
    "memory",
    "typesense_server_version",
    "regions"
  ],
  "properties": {
    "memory": {
      "type": "string",
      "description": "Memory allocation for the cluster, such as 0.5_gb, 1_gb, 2_gb, 4_gb, 8_gb, 16_gb, 32_gb, 64_gb, 96_gb, 128_gb, 192_gb, 256_gb, or 384_gb."
    },
    "vcpu": {
      "type": "string",
      "description": "vCPU configuration for the cluster, such as 2_vcpus_2_hr_burst_per_day or dedicated vCPU options."
    },
    "gpu": {
      "type": "boolean",
      "description": "Whether to provision a GPU-enabled cluster for embedding generation."
    },
    "high_performance_disk": {
      "type": "string",
      "description": "High-performance disk configuration."
    },
    "typesense_server_version": {
      "type": "string",
      "description": "Typesense Server version to deploy on the cluster."
    },
    "high_availability": {
      "type": "string",
      "description": "Whether to enable high availability with 3-node replication.",
      "enum": [
        "yes",
        "no"
      ]
    },
    "search_delivery_network": {
      "type": "string",
      "description": "Whether to enable search delivery network for global distribution.",
      "enum": [
        "yes",
        "no"
      ]
    },
    "load_balancing": {
      "type": "string",
      "description": "Whether to enable load balancing.",
      "enum": [
        "yes",
        "no"
      ]
    },
    "regions": {
      "type": "array",
      "description": "Cloud regions to deploy the cluster in.",
      "items": {
        "type": "string"
      }
    },
    "cluster_name": {
      "type": "string",
      "description": "Optional friendly name for the cluster."
    },
    "auto_upgrade_capacity": {
      "type": "boolean",
      "description": "Whether to automatically upgrade cluster capacity when needed."
    }
  }
}