docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Hypermode",
  "colors": {
    "primary": "#FF00EE",
    "light": "#CC00BE",
    "dark": "#CC00BE"
  },
  "favicon": "favicon.png",
  "banner": {
    "content": "🎉 Hypermode Agents Beta: natural language agent creation, 2,000+ integrations, export to code [Try Sidekick now! →](https://hypermode.com/login)"
  },
  "navigation": {
    "global": {
      "anchors": [
        {
          "anchor": "Hypermode Graphs (preview)",
          "icon": "chart-network",
          "color": {
            "light": "#FF00EE",
            "dark": "#CC00BE"
          },
          "href": "https://hypermode.com/login"
        },
        {
          "anchor": "Dgraph Cloud",
          "icon": "cloud",
          "color": {
            "light": "#FF00EE",
            "dark": "#CC00BE"
          },
          "href": "https://cloud.dgraph.io"
        },
        {
          "anchor": "Agents Bootcamp",
          "icon": "calendar",
          "color": {
            "light": "#FF00EE",
            "dark": "#CC00BE"
          },
          "href": "https://docs.hypermode.com/agents/30-days-of-agents/overview"
        }
      ]
    },
    "tabs": [
      {
        "tab": "Hypermode",
        "groups": [
          {
            "group": "Hypermode",
            "pages": [
              "introduction",
              "first-hypermode-agent",
              "semantic-search"
            ]
          },
          {
            "group": "Agents",
            "pages": [
              "agents/introduction",
              "agents/create-agent",
              "agents/work",
              "agents/connections",
              "agents/tasks",
              {
                "group": "Example Agents",
                "pages": [
                  "agents/example-agents",
                  "agents/agent-gallery/gtm-engineer",
                  "agents/agent-gallery/market-researcher",
                  "agents/agent-gallery/channelpulse",
                  "agents/agent-gallery/persona-builder",
                  "agents/agent-gallery/competitor-content-tracker",
                  "agents/agent-gallery/pr-opportunity-scout",
                  "agents/agent-gallery/event-webinar-optimizer",
                  "agents/agent-gallery/social-media",
                  "agents/agent-gallery/workout-scheduling",
                  "agents/agent-gallery/music-recommendation",
                  "agents/agent-gallery/github-review-bot",
                  "agents/agent-gallery/linkedin-intelligence",
                  "agents/agent-gallery/inventory-tracker"
                ]
              },
              {
                "group": "Agents Bootcamp",
                "pages": [
                  "agents/30-days-of-agents/overview",
                  "agents/30-days-of-agents/day-1",
                  "agents/30-days-of-agents/day-2",
                  "agents/30-days-of-agents/day-3",
                  "agents/30-days-of-agents/day-4",
                  "agents/30-days-of-agents/day-5"
                ]
              },
              "agents/faq"
            ]
          },
          {
            "group": "Graphs",
            "pages": [
              "graphs/overview",
              "graphs/provision",
              "graphs/connect",
              "graphs/manage-schema",
              "graphs/manage-data",
              "graphs/manage-graph",
              "graphs/graph-mcp"
            ]
          },
          {
            "group": "Tools",
            "pages": ["model-router", "hyp-cli"]
          },
          {
            "group": "Resources",
            "pages": ["security", "community-and-support"]
          }
        ]
      },
      {
        "tab": "Modus",
        "groups": [
          {
            "group": "Getting Started",
            "pages": [
              "modus/overview",
              "modus/first-modus-agent",
              "modus/functions",
              "modus/agents",
              "modus/knowledge-graphs"
            ]
          },
          {
            "group": "Building Your App",
            "pages": [
              "modus/project-structure",
              "modus/app-manifest",
              "modus/data-fetching",
              "modus/model-invoking",
              "modus/api-generation",
              "modus/authentication",
              "modus/error-handling",
              "modus/run-locally"
            ]
          },
          {
            "group": "How-To Guides",
            "pages": ["modus/deepseek-model", "modus/modus-dgraph"]
          },
          {
            "group": "SDK Reference",
            "pages": [
              {
                "group": "AssemblyScript SDK",
                "pages": [
                  "modus/sdk/assemblyscript/overview",
                  "modus/sdk/assemblyscript/agents",
                  "modus/sdk/assemblyscript/console",
                  "modus/sdk/assemblyscript/dgraph",
                  "modus/sdk/assemblyscript/graphql",
                  "modus/sdk/assemblyscript/http",
                  "modus/sdk/assemblyscript/localtime",
                  "modus/sdk/assemblyscript/models",
                  "modus/sdk/assemblyscript/mysql",
                  "modus/sdk/assemblyscript/neo4j",
                  "modus/sdk/assemblyscript/postgresql"
                ]
              },
              {
                "group": "Go SDK",
                "pages": [
                  "modus/sdk/go/overview",
                  "modus/sdk/go/agents",
                  "modus/sdk/go/console",
                  "modus/sdk/go/dgraph",
                  "modus/sdk/go/graphql",
                  "modus/sdk/go/http",
                  "modus/sdk/go/localtime",
                  "modus/sdk/go/models",
                  "modus/sdk/go/mysql",
                  "modus/sdk/go/neo4j",
                  "modus/sdk/go/postgresql"
                ]
              }
            ]
          },
          {
            "group": "Tools",
            "pages": ["modus/modus-cli"]
          },
          {
            "group": "Resources",
            "pages": ["modus/changelog"]
          }
        ]
      },
      {
        "tab": "Dgraph",
        "groups": [
          {
            "group": "Getting Started",
            "pages": [
              "dgraph/overview",
              "dgraph/why-dgraph",
              "dgraph/quickstart",
              "dgraph/guides",
              "dgraph/v25-preview"
            ]
          },
          {
            "group": "Connecting",
            "pages": [
              "dgraph/sdks/overview",
              "dgraph/sdks/go",
              "dgraph/sdks/python",
              "dgraph/sdks/java",
              "dgraph/sdks/javascript",
              "dgraph/sdks/dotnet",
              "dgraph/http"
            ]
          },
          {
            "group": "Query Language",
            "pages": [
              "dgraph/dql/json",
              "dgraph/dql/rdf",
              "dgraph/dql/schema",
              "dgraph/dql/indexes",
              {
                "group": "Query",
                "pages": [
                  "dgraph/dql/query",
                  "dgraph/dql/alias",
                  "dgraph/dql/aggregation",
                  "dgraph/dql/functions",
                  "dgraph/dql/language-support",
                  "dgraph/dql/pagination",
                  "dgraph/dql/sorting",
                  "dgraph/dql/variables"
                ]
              },
              "dgraph/dql/mutation",
              "dgraph/dql/upsert",
              "dgraph/dql/facets",
              {
                "group": "Keywords",
                "pages": [
                  "dgraph/dql/cascade",
                  "dgraph/dql/count",
                  "dgraph/dql/debug",
                  "dgraph/dql/expand",
                  "dgraph/dql/filter",
                  "dgraph/dql/fragment",
                  "dgraph/dql/groupby",
                  "dgraph/dql/ignorereflex",
                  "dgraph/dql/normalize",
                  "dgraph/dql/recurse",
                  "dgraph/dql/shortest"
                ]
              },
              "dgraph/dql/tips"
            ]
          },
          {
            "group": "GraphQL-based Development",
            "pages": [
              "dgraph/graphql/overview",
              "dgraph/graphql/quickstart",
              {
                "group": "Connecting",
                "pages": [
                  "dgraph/graphql/connecting",
                  "dgraph/graphql/api",
                  "dgraph/graphql/http"
                ]
              },
              {
                "group": "Schema",
                "pages": [
                  "dgraph/graphql/schema/overview",
                  "dgraph/graphql/schema/types",
                  "dgraph/graphql/schema/relationships",
                  "dgraph/graphql/schema/custom-dql",
                  {
                    "group": "Directives",
                    "pages": [
                      "dgraph/graphql/schema/directives/overview",
                      "dgraph/graphql/schema/directives/auth",
                      "dgraph/graphql/schema/directives/custom",
                      "dgraph/graphql/schema/directives/deprecated",
                      "dgraph/graphql/schema/directives/dgraph",
                      "dgraph/graphql/schema/directives/embedding",
                      "dgraph/graphql/schema/directives/generate",
                      "dgraph/graphql/schema/directives/ids",
                      "dgraph/graphql/schema/directives/search",
                      "dgraph/graphql/schema/directives/withsubscription"
                    ]
                  },
                  "dgraph/graphql/schema/migration",
                  "dgraph/graphql/schema/documentation",
                  "dgraph/graphql/schema/reserved",
                  "dgraph/graphql/schema/federation",
                  "dgraph/graphql/schema/graphql-dql"
                ]
              },
              {
                "group": "Queries",
                "pages": [
                  "dgraph/graphql/query/overview",
                  "dgraph/graphql/query/aggregate",
                  "dgraph/graphql/query/and-or-not",
                  "dgraph/graphql/query/cached-results",
                  "dgraph/graphql/query/cascade",
                  "dgraph/graphql/query/order-page",
                  "dgraph/graphql/query/persistent-queries",
                  "dgraph/graphql/query/search-filtering",
                  "dgraph/graphql/query/skip-include",
                  "dgraph/graphql/query/variables",
                  "dgraph/graphql/query/vector-similarity"
                ]
              },
              {
                "group": "Mutations",
                "pages": [
                  "dgraph/graphql/mutation/overview",
                  "dgraph/graphql/mutation/add",
                  "dgraph/graphql/mutation/deep",
                  "dgraph/graphql/mutation/delete",
                  "dgraph/graphql/mutation/update",
                  "dgraph/graphql/mutation/upsert"
                ]
              },
              "dgraph/graphql/subscriptions",
              {
                "group": "Security",
                "pages": [
                  "dgraph/graphql/security/overview",
                  "dgraph/graphql/security/auth-tips",
                  "dgraph/graphql/security/cors",
                  "dgraph/graphql/security/graphtraversal-rules",
                  "dgraph/graphql/security/jwt",
                  "dgraph/graphql/security/mutations",
                  "dgraph/graphql/security/rbac-rules"
                ]
              },
              {
                "group": "Lambda",
                "pages": [
                  "dgraph/graphql/lambda/overview",
                  "dgraph/graphql/lambda/query",
                  "dgraph/graphql/lambda/mutation",
                  "dgraph/graphql/lambda/field",
                  "dgraph/graphql/lambda/webhook"
                ]
              }
            ]
          },
          {
            "group": "Administration",
            "pages": [
              "dgraph/admin/schema",
              "dgraph/admin/update-types",
              "dgraph/admin/drop-data",
              {
                "group": "Observability",
                "pages": [
                  "dgraph/admin/logs",
                  "dgraph/admin/metrics",
                  "dgraph/admin/traces",
                  "dgraph/admin/increment-tool",
                  "dgraph/admin/debug",
                  "dgraph/admin/sentry"
                ]
              },
              {
                "group": "Data Migration",
                "pages": [
                  "dgraph/admin/import",
                  "dgraph/admin/live-loader",
                  "dgraph/admin/bulk-loader",
                  "dgraph/admin/import-csv",
                  "dgraph/admin/import-mysql",
                  "dgraph/admin/export"
                ]
              },
              {
                "group": "Self-Managed Deployments",
                "pages": [
                  "dgraph/self-managed/overview",
                  "dgraph/self-managed/data-compression",
                  "dgraph/self-managed/download",
                  "dgraph/self-managed/dgraph-alpha",
                  "dgraph/self-managed/dgraph-zero",
                  "dgraph/self-managed/config",
                  "dgraph/self-managed/tls-configuration",
                  "dgraph/self-managed/decrypt",
                  "dgraph/self-managed/ports-usage",
                  "dgraph/self-managed/monitoring",
                  "dgraph/self-managed/single-host-setup",
                  "dgraph/self-managed/cluster-setup",
                  "dgraph/self-managed/cluster-types",
                  "dgraph/self-managed/single-server-cluster",
                  "dgraph/self-managed/ha-cluster",
                  "dgraph/self-managed/monitoring-cluster",
                  "dgraph/self-managed/cluster-checklist",
                  "dgraph/self-managed/troubleshooting"
                ]
              }
            ]
          },
          {
            "group": "Tools",
            "pages": [
              {
                "group": "Ratel",
                "pages": [
                  "dgraph/ratel/overview",
                  "dgraph/ratel/console",
                  "dgraph/ratel/connection",
                  "dgraph/ratel/schema",
                  "dgraph/ratel/cluster",
                  "dgraph/ratel/backups"
                ]
              },
              {
                "group": "CLI",
                "pages": [
                  "dgraph/cli/command-reference",
                  "dgraph/cli/completion"
                ]
              }
            ]
          },
          {
            "group": "Resources",
            "pages": [
              "dgraph/changelog",
              "dgraph/glossary",
              {
                "group": "Concepts",
                "pages": [
                  "dgraph/concepts/acl",
                  "dgraph/concepts/badger",
                  "dgraph/concepts/clients",
                  "dgraph/concepts/consistency-model",
                  "dgraph/concepts/discovery",
                  "dgraph/concepts/dql-graphql-layering",
                  "dgraph/concepts/dql",
                  "dgraph/concepts/facets",
                  "dgraph/concepts/graphql",
                  "dgraph/concepts/group",
                  "dgraph/concepts/index-tokenize",
                  "dgraph/concepts/lambda",
                  "dgraph/concepts/minimizing-network-calls",
                  "dgraph/concepts/namespace-tenant",
                  "dgraph/concepts/posting-list",
                  "dgraph/concepts/protocol-buffers",
                  "dgraph/concepts/queries-process",
                  "dgraph/concepts/raft",
                  "dgraph/concepts/relationships",
                  "dgraph/concepts/replication",
                  "dgraph/concepts/transaction-mutation",
                  "dgraph/concepts/transactions",
                  "dgraph/concepts/wal-memtable",
                  "dgraph/concepts/workers"
                ]
              },
              {
                "group": "Enterprise",
                "pages": [
                  "dgraph/enterprise/overview",
                  "dgraph/enterprise/license",
                  "dgraph/enterprise/access-control-lists",
                  "dgraph/enterprise/audit-logs",
                  "dgraph/enterprise/binary-backups",
                  "dgraph/enterprise/lsbackup",
                  "dgraph/enterprise/change-data-capture",
                  "dgraph/enterprise/encryption-at-rest",
                  "dgraph/enterprise/learner-nodes",
                  "dgraph/enterprise/multitenancy"
                ]
              }
            ]
          }
        ]
      },
      {
        "tab": "Badger",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["badger/overview", "badger/quickstart"]
          },
          {
            "group": "Resources",
            "pages": ["badger/troubleshooting", "badger/design"]
          }
        ]
      }
    ]
  },
  "logo": {
    "light": "/images/logo/light.svg",
    "dark": "/images/logo/dark.svg"
  },
  "background": {
    "color": {
      "light": "#FFFFFF",
      "dark": "#101010"
    }
  },
  "navbar": {
    "links": [
      {
        "label": "Status",
        "href": "https://status.hypermode.com"
      },
      {
        "label": "Blog",
        "href": "https://hypermode.com/blog"
      }
    ]
  },
  "footer": {
    "socials": {
      "discord": "https://discord.hypermode.com",
      "github": "https://github.com/hypermodeinc",
      "youtube": "https://www.youtube.com/@hypermodeinc",
      "x": "https://x.com/hypermodeinc",
      "linkedin": "https://www.linkedin.com/company/hypermode"
    }
  },
  "integrations": {
    "fathom": {
      "siteId": "LQSVRZXR"
    },
    "posthog": {
      "apiKey": "phc_Q0NhwRIDTmaMNBAkZlNrGQJEKnU8UL5ryhynxmvJalB"
    },
    "koala": {
      "publicApiKey": "pk_11b969347385f3731b3fb58b4a358e5e1720"
    }
  },
  "seo": {
    "indexing": "all"
  },
  "redirects": [
    {
      "source": "/",
      "destination": "/introduction",
      "permanent": true
    },
    {
      "source": "/modus/sdk/console",
      "destination": "/modus/sdk/assemblyscript/console"
    },
    {
      "source": "/modus/sdk/dgraph",
      "destination": "/modus/sdk/assemblyscript/dgraph"
    },
    {
      "source": "/modus/sdk/graphql",
      "destination": "/modus/sdk/assemblyscript/graphql"
    },
    {
      "source": "/modus/sdk/http",
      "destination": "/modus/sdk/assemblyscript/http"
    },
    {
      "source": "/modus/sdk/localtime",
      "destination": "/modus/sdk/assemblyscript/localtime"
    },
    {
      "source": "/modus/sdk/models",
      "destination": "/modus/sdk/assemblyscript/models"
    },
    {
      "source": "/modus/sdk/mysql",
      "destination": "/modus/sdk/assemblyscript/mysql"
    },
    {
      "source": "/modus/sdk/neo4j",
      "destination": "/modus/sdk/assemblyscript/neo4j"
    },
    {
      "source": "/modus/sdk/postgresql",
      "destination": "/modus/sdk/assemblyscript/postgresql"
    },
    {
      "source": "/graphs/deploy",
      "destination": "/graphs/provision"
    },
    {
      "source": "/hosted-models",
      "destination": "/model-router"
    }
  ]
}