mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Documentation",
  "openapi": ["reference/openapi-auth.yaml", "reference/openapi-storage.yaml"],
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg"
  },
  "favicon": "/favicon.svg",
  "colors": {
    "primary": "#3787ff",
    "light": "#569aff",
    "dark": "#1874ff",
    "anchors": {
      "from": "#1874ff",
      "to": "#569aff"
    }
  },
  "topbarLinks": [
    {
      "name": "Support",
      "url": "mailto:support@nhost.io"
    }
  ],
  "topbarCtaButton": {
    "name": "Dashboard",
    "url": "https://app.nhost.io"
  },
  "tabs": [
    {
      "name": "Reference",
      "url": "reference"
    },
    {
      "name": "Guides",
      "url": "guides"
    }
  ],
  "anchors": [
    {
      "name": "Documentation",
      "icon": "book-open-cover",
      "url": "introduction"
    },
    {
      "name": "Community",
      "icon": "discord",
      "url": "https://discord.com/nhost"
    },
    {
      "name": "Blog",
      "icon": "newspaper",
      "url": "https://nhost.io/blog"
    }
  ],
  "navigation": [
    {
      "group": "Overview",
      "pages": ["introduction"]
    },
    {
      "group": "Product",
      "pages": ["product/database", "product/graphql", "product/authentication", "product/storage", "product/functions", "product/run", "product/ai"]
    },
    {
      "group": "Platform",
      "pages": [
        "platform/compute-resources",
        "platform/service-replicas",
        {
          "group": "Monitoring",
          "icon": "monitor-waveform",
          "pages": ["platform/metrics"]
        },
        "platform/environment-variables",
        "platform/secrets",
        "platform/deployments",
        "platform/custom-domains"
      ]
    },
    {
      "group": "Development & CLI",
      "pages": ["development/cli/overview", "development/cli/getting-started", "development/cli/commands"]
    },
    {
      "group": "API Documentation",
      "pages": ["reference/overview"]
    },
    {
      "group": "Quickstarts",
      "pages": ["guides/quickstarts/react", "guides/quickstarts/nextjs", "guides/quickstarts/vue"]
    },
    {
      "group": "Tutorials",
      "pages": ["guides/tutorials/react", "guides/tutorials/nextjs", "guides/tutorials/vue"]
    },
    {
      "group": "Database",
      "pages": ["guides/database/configuring-postgres", "guides/database/access", "guides/database/extensions", "guides/database/performance"]
    },
    {
        "group": "AI",
        "pages": [
            "guides/ai/enabling-service",
            "guides/ai/local-development",
            "guides/ai/auto-embeddings",
            "guides/ai/assistants",
            "guides/ai/dev-assistant"
        ]
    },
    {
      "group": "Authentication",
      "pages": [
        "guides/auth/overview",
        "guides/auth/users",
        {
          "group": "Social Sign In",
          "icon": "at",
          "pages": [
            "guides/auth/social/sign-in-apple",
            "guides/auth/social/sign-in-discord",
            "guides/auth/social/sign-in-facebook",
            "guides/auth/social/sign-in-github",
            "guides/auth/social/sign-in-google",
            "guides/auth/social/sign-in-linkedin",
            "guides/auth/social/sign-in-spotify",
            "guides/auth/social/sign-in-twitch",
            "guides/auth/social/sign-in-workos"
          ]
        },
        "guides/auth/social-connect",
        "guides/auth/sign-in-email-password",
        "guides/auth/sign-in-magic-link",
        "guides/auth/sign-in-phone-number",
        "guides/auth/sign-in-webauthn",
        "guides/auth/elevated-permissions",
        "guides/auth/email-templates",
        "guides/auth/custom-jwts"
      ]
    },
    {
      "group": "API / Hasura",
      "pages": [
          "guides/api/configuring-hasura",
          "guides/api/permissions",
          "guides/api/advanced_features"
      ]
    },
    {
      "group": "Storage",
      "pages": ["guides/storage/overview", "guides/storage/cdn", "guides/storage/antivirus"]
    },
    {
      "group": "Functions",
      "pages": ["guides/functions/overview"]
    },
    {
      "group": "Run",
      "pages": ["guides/run/getting-started", "guides/run/configuration", "guides/run/networking", "guides/run/health-checks", "guides/run/resources", "guides/run/registry", "guides/run/local-development", "guides/run/configuration-overlays", "guides/run/cli-deployments" ]
    },
    {
      "group": "CLI",
      "pages": ["guides/cli/local-development", "guides/cli/migrate-config", "guides/cli/multiple-projects", "guides/cli/configuration-overlays", "guides/cli/seeds"]
    },
    {
      "group": "Backend Services",
      "pages": [

        {
          "group": "Authentication",
          "icon": "users",
          "pages": [
            {
              "group": "Email and Password",
              "icon": "envelope",
              "pages": [
                "reference/auth/sign-up-email-and-password",
                "reference/auth/sign-in-email-and-password"
              ]
            },
            {
              "group": "Passwordless",
              "icon": "message-sms",
              "pages": [
                "reference/auth/sign-in-email-passwordless",
                "reference/auth/sign-in-sms-passwordless",
                "reference/auth/sign-in-sms-passwordless-otp"
              ]
            },
            {
              "group": "OAuth",
              "icon": "at",
              "pages": [
                "reference/auth/sign-in-oauth-provider",
                "reference/auth/oauth-callback-url-that-will-be-used-by-the-oauth-provider-to-redirect-to-the-client-application-attention:-all-providers-are-using-a-get-operation-except-apple-and-azure-ad-that-use-post"
              ]
            },
            {
              "group": "WebAuthn",
              "icon": "atom",
              "pages": [
                "reference/auth/sign-up-using-email-via-fido2-webauthn-authentication",
                "reference/auth/verfiy-fido2-webauthn-authentication-and-complete-signup",
                "reference/auth/sign-in-using-email-via-fido2-webauthn-authentication",
                "reference/auth/verfiy-fido2-webauthn-authentication-using-public-key-cryptography",
                "reference/auth/elevate-webauthn",
                "reference/auth/elevate-webauthn-verify"
              ]
            },
            {
              "group": "Anonymous",
              "icon": "luchador-mask",
              "pages": [
                "reference/auth/sign-in-anonymous",
                "reference/auth/deanonymize-an-anonymous-user-in-adding-missing-email-or-email+password-depending-on-the-chosen-authentication-method-will-send-a-confirmation-email-if-the-server-is-configured-to-do-so"
              ]
            },
            {
              "group": "MFA",
              "icon": "message-sms",
              "pages": [
                "reference/auth/generate-a-secret-to-request-the-activation-of-time-based-one-time-password-totp-multi-factor-authentication",
                "reference/auth/sign-in-totp",
                "reference/auth/activatedeactivate-multi-factor-authentication"
              ]
            },
            {
              "group": "User",
              "icon": "user",
              "pages": [
                "reference/auth/change-the-current-users-email",
                "reference/auth/send-an-email-asking-the-user-to-reset-their-password",
                "reference/auth/send-an-email-to-verify-the-account",
                "reference/auth/set-a-new-password",
                "reference/auth/get-user-information",
                "reference/auth/refresh-the-oauth-access-tokens-of-a-given-user-you-must-be-an-admin-to-perform-this-operation",
                "reference/auth/initialize-adding-of-a-new-webauthn-security-key-device-browser",
                "reference/auth/verfiy-adding-of-a-new-webauth-security-key-device-browser",
                "reference/auth/create-personal-access-token-pat"
              ]
            },
            "reference/auth/sign-out"
          ]
        },
        {
          "group": "Storage",
          "icon": "file",
          "pages": [
            "reference/storage/upload-file",
            "reference/storage/replace-file",
            "reference/storage/delete-file",
            "reference/storage/download-file",
            "reference/storage/download-file-metadata",
            "reference/storage/presigned-url",
            "reference/storage/get-file-content"
          ]
        }
      ]
    },
    {
        "group": "GraphQL",
        "pages": [
            {
                "group": "AI",
                "pages": [
                    "reference/graphql/ai/overview",
                    {
                        "group": "Query",
                        "pages": [
                            "reference/graphql/ai/query/assistant",
                            "reference/graphql/ai/query/assistants",
                            "reference/graphql/ai/query/session",
                            "reference/graphql/ai/query/sessionMessages",
                            "reference/graphql/ai/query/sessions"
                        ]
                    },
                    {
                        "group": "Mutation",
                        "pages": [
                            "reference/graphql/ai/mutation/insertAssistant",
                            "reference/graphql/ai/mutation/updateAssistant",
                            "reference/graphql/ai/mutation/deleteAssistant",
                            "reference/graphql/ai/mutation/startSession",
                            "reference/graphql/ai/mutation/deleteSession",
                            "reference/graphql/ai/mutation/sendMessage",
                            "reference/graphql/ai/mutation/startDevSession",
                            "reference/graphql/ai/mutation/sendDevMessage"
                        ]
                    }
                ]
            }

        ]
    },
    {
      "group": "Client Libraries",
      "pages": [
        {
          "group": "JavaScript",
          "icon": "js",
          "pages": [
            {
              "group": "nhost-js",
              "pages": ["reference/javascript/nhost-js/nhost-client", "reference/javascript/nhost-js/set-role", "reference/javascript/nhost-js/unset-role"]
            },
            {
              "group": "Auth",
              "pages": [
                "reference/javascript/auth/hasura-auth-client",
                "reference/javascript/auth/change-email",
                "reference/javascript/auth/change-password",
                "reference/javascript/auth/create-pat",
                "reference/javascript/auth/get-access-token",
                "reference/javascript/auth/get-authentication-status",
                "reference/javascript/auth/get-decoded-access-token",
                "reference/javascript/auth/get-hasura-claim",
                "reference/javascript/auth/get-hasura-claims",
                "reference/javascript/auth/get-session",
                "reference/javascript/auth/get-user",
                "reference/javascript/auth/is-authenticated",
                "reference/javascript/auth/is-authenticated-async",
                "reference/javascript/auth/on-auth-state-changed",
                "reference/javascript/auth/on-token-changed",
                "reference/javascript/auth/refresh-session",
                "reference/javascript/auth/reset-password",
                "reference/javascript/auth/send-verification-email",
                "reference/javascript/auth/sign-in",
                "reference/javascript/auth/sign-in-pat",
                "reference/javascript/auth/sign-out",
                "reference/javascript/auth/sign-up",
                "reference/javascript/auth/add-security-key",
                "reference/javascript/auth/elevate-email-security-key",
                "reference/javascript/auth/connect-provider"
              ]
            },
            {
              "group": "Storage",
              "pages": [
                "reference/javascript/storage/hasura-storage-client",
                "reference/javascript/storage/upload",
                "reference/javascript/storage/download",
                "reference/javascript/storage/get-presigned-url",
                "reference/javascript/storage/get-public-url",
                "reference/javascript/storage/delete",
                "reference/javascript/storage/set-access-token",
                "reference/javascript/storage/set-admin-secret",
                "reference/javascript/storage/set-headers",
                "reference/javascript/storage/unset-headers",
                "reference/javascript/storage/get-headers"
              ]
            },
            {
              "group": "GraphQL ",
              "pages": [
                "reference/javascript/graphql/nhost-graphql-client",
                "reference/javascript/graphql/get-url",
                "reference/javascript/graphql/set-access-token",
                "reference/javascript/graphql/request",
                "reference/javascript/graphql/set-headers",
                "reference/javascript/graphql/unset-headers",
                "reference/javascript/graphql/get-headers"
              ]
            },
            {
              "group": "Functions ",
              "pages": [
                "reference/javascript/functions/create-functions-client",
                "reference/javascript/functions/call",
                "reference/javascript/functions/set-access-token"
              ]
            }
          ]
        },
        {
          "group": "React",
          "icon": "react",
          "pages": [
            "reference/react/nhost-client",
            "reference/react/signed-in",
            "reference/react/signed-out",
            "reference/react/use-access-token",
            "reference/react/use-add-security-key",
            "reference/react/use-authenticated",
            "reference/react/use-authentication-status",
            "reference/react/use-change-email",
            "reference/react/use-change-password",
            "reference/react/use-config-mfa",
            "reference/react/use-decoded-access-token",
            "reference/react/use-file-upload",
            "reference/react/use-file-upload-item",
            "reference/react/use-hasura-claim",
            "reference/react/use-hasura-claims",
            "reference/react/use-multiple-files-upload",
            "reference/react/use-nhost-client",
            "reference/react/use-provider-link",
            "reference/react/use-reset-password",
            "reference/react/use-send-verification-email",
            "reference/react/use-sign-in-anonymous",
            "reference/react/use-sign-in-email-password",
            "reference/react/use-sign-in-email-passwordless",
            "reference/react/use-sign-in-email-security-key",
            "reference/react/use-sign-in-pat",
            "reference/react/use-sign-in-sms-passwordless",
            "reference/react/use-sign-out",
            "reference/react/use-sign-up-email-password",
            "reference/react/use-sign-up-email-security-key-email",
            "reference/react/use-elevate-security-key-email",
            "reference/react/use-user-avatar-url",
            "reference/react/use-user-data",
            "reference/react/use-user-default-role",
            "reference/react/use-user-display-name",
            "reference/react/use-user-email",
            "reference/react/use-user-id",
            "reference/react/use-user-is-anonymous",
            "reference/react/use-user-locale",
            "reference/react/use-user-roles"
          ]
        },
        {
          "group": "Next.js",
          "icon": "react",
          "pages": [
            "reference/nextjs/nhost-client",
            "reference/nextjs/signed-in",
            "reference/nextjs/signed-out",
            "reference/nextjs/create-server-side-client",
            "reference/nextjs/get-nhost-session",
            "reference/nextjs/use-access-token",
            "reference/nextjs/use-add-security-key",
            "reference/nextjs/use-authenticated",
            "reference/nextjs/use-authentication-status",
            "reference/nextjs/use-change-email",
            "reference/nextjs/use-change-password",
            "reference/nextjs/use-config-mfa",
            "reference/nextjs/use-decoded-access-token",
            "reference/nextjs/use-file-upload",
            "reference/nextjs/use-file-upload-item",
            "reference/nextjs/use-hasura-claim",
            "reference/nextjs/use-hasura-claims",
            "reference/nextjs/use-multiple-files-upload",
            "reference/nextjs/use-nhost-client",
            "reference/nextjs/use-provider-link",
            "reference/nextjs/use-reset-password",
            "reference/nextjs/use-send-verification-email",
            "reference/nextjs/use-sign-in-anonymous",
            "reference/nextjs/use-sign-in-email-password",
            "reference/nextjs/use-sign-in-email-passwordless",
            "reference/nextjs/use-sign-in-email-security-key",
            "reference/nextjs/use-sign-in-pat",
            "reference/nextjs/use-sign-in-sms-passwordless",
            "reference/nextjs/use-sign-out",
            "reference/nextjs/use-sign-up-email-password",
            "reference/nextjs/use-sign-up-email-security-key-email",
            "reference/nextjs/use-elevate-security-key-email",
            "reference/nextjs/use-user-avatar-url",
            "reference/nextjs/use-user-data",
            "reference/nextjs/use-user-default-role",
            "reference/nextjs/use-user-display-name",
            "reference/nextjs/use-user-email",
            "reference/nextjs/use-user-id",
            "reference/nextjs/use-user-is-anonymous",
            "reference/nextjs/use-user-locale",
            "reference/nextjs/use-user-roles"
          ]
        },
        {
          "group": "Vue",
          "icon": "vuejs",
          "pages": [
            "reference/vue/nhost-client",
            "reference/vue/use-access-token",
            "reference/vue/use-authenticated",
            "reference/vue/use-authentication-status",
            "reference/vue/use-change-email",
            "reference/vue/use-change-password",
            "reference/vue/use-decoded-access-token",
            "reference/vue/use-file-upload",
            "reference/vue/use-file-upload-item",
            "reference/vue/use-hasura-claim",
            "reference/vue/use-hasura-claims",
            "reference/vue/use-multiple-files-upload",
            "reference/vue/use-nhost-client",
            "reference/vue/use-provider-link",
            "reference/vue/use-reset-password",
            "reference/vue/use-send-verification-email",
            "reference/vue/use-sign-in-anonymous",
            "reference/vue/use-sign-in-email-password",
            "reference/vue/use-sign-in-email-passwordless",
            "reference/vue/use-sign-in-pat",
            "reference/vue/use-sign-in-sms-passwordless",
            "reference/vue/use-sign-out",
            "reference/vue/use-sign-up-email-password",
            "reference/vue/use-user-avatar-url",
            "reference/vue/use-user-data",
            "reference/vue/use-user-default-role",
            "reference/vue/use-user-display-name",
            "reference/vue/use-user-email",
            "reference/vue/use-user-id",
            "reference/vue/use-user-is-anonymous",
            "reference/vue/use-user-locale",
            "reference/vue/use-user-roles",
            "reference/vue/use-add-security-key",
            "reference/vue/use-elevate-security-key-email",
            "reference/vue/use-sign-in-email-security-key",
            "reference/vue/use-sign-up-email-security-key"
          ]
        }
      ]
    }
  ],
  "footerSocials": {
    "twitter": "https://twitter.com/nhost",
    "github": "https://github.com/nhost",
    "linkedin": "https://www.linkedin.com/company/nhost"
  }
}