documentation/docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Onyx Documentation",
  "colors": {
    "primary": "#0069ED",
    "light": "#4D9CFF",
    "dark": "#0050B4"
  },
  "favicon": "assets/logo/onyx_favicon.svg",
  "navigation": {
    "tabs": [
      {
        "tab": "Overview",
        "icon": "house",
        "pages": [
          {
            "group": "Getting Started",
            "pages": [
              "welcome",
              "overview/getting_started/use_cases",
              "overview/getting_started/faq"
            ]
          },
          {
            "group": "Core Features",
            "pages": [
              "overview/core_features/chat",
              "overview/core_features/agents",
              "overview/core_features/actions",
              "overview/core_features/connectors",
              "overview/core_features/internal_search",
              "overview/core_features/web_search",
              "overview/core_features/code_interpreter",
              "overview/core_features/image_generation",
              "overview/core_features/workflows"
            ]
          },
          {
            "group": "Onyx Anywhere",
            "pages": [
              "overview/onyx_anywhere/web_interface",
              "overview/onyx_anywhere/slack",
              "overview/onyx_anywhere/chrome_extension",
              "overview/onyx_anywhere/mobile_app"
            ]
          },
          {
            "group": "Miscellaneous",
            "pages": [
              "overview/miscellaneous/open_source_statement",
              "overview/miscellaneous/contact_us"
            ]
          }
        ]
      },
      {
        "tab": "Deployment",
        "icon": "server",
        "pages": [
          {
            "group": "Getting Started",
            "pages": [
              "deployment/overview",
              "deployment/getting_started/quickstart",
              "deployment/getting_started/resourcing"
            ]
          },
          {
            "group": "Local",
            "pages": [
              "deployment/local/docker",
              "deployment/local/kubernetes",
              "deployment/local/terraform"
            ]
          },
          {
            "group": "Cloud",
            "pages": [
              {
                "group": "AWS",
                "icon": "aws",
                "pages": [
                  "deployment/cloud/aws/ec2",
                  "deployment/cloud/aws/eks",
                  "deployment/cloud/aws/rds"
                ]
              },
              "deployment/cloud/gcp",
              "deployment/cloud/azure",
              "deployment/cloud/digital_ocean"
            ]
          },
          {
            "group": "Authentication",
            "pages": [
              "deployment/authentication/basic",
              "deployment/authentication/oauth",
              "deployment/authentication/oidc",
              "deployment/authentication/saml"
            ]
          },
          {
            "group": "Configuration",
            "pages": [
              "deployment/configuration/configuration",
              "deployment/configuration/chrome_extension"
            ]
          },
          {
            "group": "Miscellaneous",
            "pages": [
              "deployment/miscellaneous/enterprise_edition",
              "deployment/miscellaneous/release_process",
              "deployment/miscellaneous/contact_us"
            ]
          }
        ]
      },
      {
        "tab": "Admins",
        "icon": "user-shield",
        "pages": [
          {
            "group": "Getting Started",
            "pages": [
              "admins/overview",
              "admins/getting_started/slack_bot_setup",
              "admins/getting_started/enterprise_edition"
            ]
          },
          {
            "group": "AI Models",
            "pages": [
              "admins/ai_models/overview",
              "admins/ai_models/openai",
              "admins/ai_models/ollama",
              "admins/ai_models/azure_openai",
              "admins/ai_models/anthropic",
              "admins/ai_models/bedrock",
              "admins/ai_models/google_ai",
              "admins/ai_models/openrouter",
              "admins/ai_models/custom_inference_provider"
            ]
          },
          {
            "group": "Connectors",
            "pages": [
              "admins/connectors/overview",
              {
                "group": "Supported Connectors",
                "icon": "plug",
                "pages": [
                  "admins/connectors/official/airtable",
                  "admins/connectors/official/asana",
                  "admins/connectors/official/bitbucket",
                  "admins/connectors/official/bookstack",
                  "admins/connectors/official/clickup",
                  "admins/connectors/official/confluence",
                  "admins/connectors/official/discord",
                  "admins/connectors/official/discourse",
                  "admins/connectors/official/document360",
                  "admins/connectors/official/dropbox",
                  "admins/connectors/official/egnyte",
                  "admins/connectors/official/file",
                  "admins/connectors/official/fireflies",
                  "admins/connectors/official/freshdesk",
                  "admins/connectors/official/gitbook",
                  "admins/connectors/official/github",
                  "admins/connectors/official/gitlab",
                  {
                    "group": "Gmail",
                    "pages": [
                      "admins/connectors/official/gmail/overview",
                      "admins/connectors/official/gmail/oauth",
                      "admins/connectors/official/gmail/service_account"
                    ]
                  },
                  {
                    "group": "Google Drive",
                    "pages": [
                      "admins/connectors/official/google_drive/overview",
                      "admins/connectors/official/google_drive/oauth",
                      "admins/connectors/official/google_drive/service_account"
                    ]
                  },
                  "admins/connectors/official/google_sites",
                  "admins/connectors/official/google_storage",
                  "admins/connectors/official/gong",
                  "admins/connectors/official/guru",
                  "admins/connectors/official/highspot",
                  "admins/connectors/official/hubspot",
                  "admins/connectors/official/jira",
                  "admins/connectors/official/linear",
                  "admins/connectors/official/notion",
                  "admins/connectors/official/oci_storage",
                  "admins/connectors/official/productboard",
                  "admins/connectors/official/r2",
                  "admins/connectors/official/requesttracker",
                  "admins/connectors/official/salesforce",
                  {
                    "group": "S3",
                    "pages": [
                      "admins/connectors/official/s3/overview",
                      "admins/connectors/official/s3/access-keys",
                      "admins/connectors/official/s3/assume-role",
                      "admins/connectors/official/s3/iam-role"
                    ]
                  },
                  {
                    "group": "SharePoint",
                    "pages": [
                      "admins/connectors/official/sharepoint/sharepoint",
                      "admins/connectors/official/sharepoint/client-secret",
                      "admins/connectors/official/sharepoint/certificate"
                    ]
                  },
                  {
                    "group": "Slack",
                    "pages": [
                      "admins/connectors/official/slack/slack_indexed",
                      "admins/connectors/official/slack/slack_federated"
                    ]
                  },
                  "admins/connectors/official/slab",
                  "admins/connectors/official/teams",
                  "admins/connectors/official/web",
                  "admins/connectors/official/xenforo",
                  "admins/connectors/official/zendesk",
                  "admins/connectors/official/zulip"
                ]
              }
            ]
          },
          {
            "group": "Actions",
            "pages": [
              "admins/actions/overview",
              "admins/actions/web_search",
              "admins/actions/mcp",
              "admins/actions/openapi"
            ]
          },
          {
            "group": "Agents",
            "pages": [
              "admins/agents/overview"
            ]
          },
          {
            "group": "User Management",
            "pages": [
              "admins/user_management/users_and_groups",
              "admins/user_management/api_keys"
            ]
          },
          {
            "group": "Advanced Configs",
            "pages": [
              "admins/advanced_configs/search_configs",
              "admins/advanced_configs/doc_processing",
              "admins/advanced_configs/rate_limits",
              "admins/advanced_configs/workspace_settings",
              "admins/advanced_configs/white_labeling",
              "admins/advanced_configs/llm_access_controls"
            ]
          },
          {
            "group": "Analytics",
            "pages": [
              "admins/analytics/overview"
            ]
          },
          {
            "group": "Curators",
            "pages": [
              "admins/curators/overview",
              "admins/curators/curator_responsibilities",
              "admins/curators/curator_guide"
            ]
          },
          {
            "group": "Miscellaneous",
            "pages": [
              "admins/miscellaneous/contact_us"
            ]
          }
        ]
      },
      {
        "tab": "Developers",
        "icon": "square-terminal",
        "pages": [
          {
            "group": "Getting Started",
            "pages": [
              "developers/overview",
              "developers/core_concepts"
            ]
          },
          {
            "group": "Guides & Examples",
            "icon": "book-open",
            "pages": [
              "developers/guides/chat_guide",
              "developers/guides/index_files_ingestion_api",
              "developers/guides/create_connector"
            ]
          },
          {
            "group": "API Reference",
            "pages": [
              {
                "group": "Chat",
                "icon": "comment",
                "pages": [
                  "developers/api_reference/chat/get_chat_session",
                  "developers/api_reference/chat/create_chat_session",
                  "developers/api_reference/chat/send_message",
                  "developers/api_reference/chat/send_message_simple",
                  "developers/api_reference/chat/upload_file",
                  "developers/api_reference/chat/delete_chat",
                  "developers/api_reference/chat/share_chat_session",
                  "developers/api_reference/chat/search_chats",
                  "developers/api_reference/chat/create_folder",
                  "developers/api_reference/chat/add_chat_to_folder"
                ]
              },
              {
                "group": "Search",
                "icon": "magnifying-glass",
                "pages": [
                  "developers/api_reference/search/get_document_by_id",
                  "developers/api_reference/search/document_search"
                ]
              },
              {
                "group": "Agents",
                "icon": "robot",
                "pages": [
                  "developers/api_reference/agents/list_agents",
                  "developers/api_reference/agents/get_agent_by_id",
                  "developers/api_reference/agents/create_agent",
                  "developers/api_reference/agents/update_agent",
                  "developers/api_reference/agents/delete_agent"
                ]
              },
              {
                "group": "Actions",
                "icon": "play",
                "pages": [
                  "developers/api_reference/actions/list_actions",
                  "developers/api_reference/actions/get_action_by_id",
                  "developers/api_reference/actions/create_action",
                  "developers/api_reference/actions/update_action",
                  "developers/api_reference/actions/delete_action"
                ]
              },
              {
                "group": "Connectors",
                "icon": "plug",
                "pages": [
                  "developers/api_reference/files_connectors/create_connector",
                  "developers/api_reference/files_connectors/list_credentials",
                  "developers/api_reference/files_connectors/associate_connector_credential"
                ]
              },
              {
                "group": "Documents & Ingestion",
                "icon": "page",
                "pages": [
                  "developers/api_reference/files_connectors/get_document_by_id",
                  "developers/api_reference/files_connectors/list_ingestion_documents",
                  "developers/api_reference/files_connectors/ingest_document",
                  "developers/api_reference/files_connectors/delete_document_by_id",
                  "developers/api_reference/miscellaneous/set_document_boost"
                ]
              },
              {
                "group": "User Management",
                "icon": "user",
                "pages": [
                  "developers/api_reference/user_management/list_users",
                  "developers/api_reference/user_management/get_user_by_id",
                  "developers/api_reference/user_management/create_user",
                  "developers/api_reference/user_management/update_user",
                  "developers/api_reference/user_management/delete_user",
                  "developers/api_reference/user_management/invite_user",
                  "developers/api_reference/user_management/cancel_user_invite",
                  "developers/api_reference/user_management/reset_user_password"
                ]
              },
              {
                "group": "Group Management",
                "icon": "user-group",
                "pages": [
                  "developers/api_reference/group_management/list_groups",
                  "developers/api_reference/group_management/create_group",
                  "developers/api_reference/group_management/update_group",
                  "developers/api_reference/group_management/delete_group"
                ]
              },
              {
                "group": "Analytics",
                "icon": "chart-line",
                "pages": [
                  "developers/api_reference/analytics/get_query_analytics",
                  "developers/api_reference/analytics/get_user_analytics",
                  "developers/api_reference/analytics/get_onyxbot_analytics",
                  "developers/api_reference/analytics/get_assistant_stats",
                  "developers/api_reference/analytics/read_usage_report",
                  "developers/api_reference/analytics/start_query_history_export"
                ]
              },
              {
                "group": "Miscellaneous",
                "icon": "list",
                "pages": [
                  "developers/api_reference/miscellaneous/health_check",
                  "developers/api_reference/miscellaneous/set_rate_limit",
                  "developers/api_reference/miscellaneous/delete_rate_limit",
                  "developers/api_reference/miscellaneous/get_versions"
                ]
              }
            ]
          },
          {
            "group": "Miscellaneous",
            "pages": [
              "developers/contact_us"
            ]
          }
        ]
      },
      {
        "tab": "Security",
        "icon": "shield",
        "pages": [
          {
            "group": "Architecture",
            "pages": [
              "security/architecture/system_description",
              "security/architecture/data_flows",
              "security/architecture/data_storage",
              "security/architecture/access_controls",
              "security/architecture/faq"
            ]
          },
          {
            "group": "Self-hosted",
            "pages": [
              "security/self_hosted/data_processing",
              "security/self_hosted/faq"
            ]
          },
          {
            "group": "Onyx Cloud",
            "pages": [
              "security/onyx_cloud/multi_tenant",
              "security/onyx_cloud/single_tenant",
              "security/onyx_cloud/compliance"
            ]
          },
          {
            "group": "Miscellaneous",
            "pages": [
              "security/contact_us"
            ]
          }
        ]
      },
      {
        "tab": "Changelog",
        "icon": "clock-rotate-left",
        "pages": [
          "changelog"
        ]
      }
    ],
    "global": {
      "anchors": [
        {
          "anchor": "Website",
          "href": "https://onyx.app/",
          "icon": "globe"
        },
        {
          "anchor": "Discord",
          "href": "https://discord.gg/TDJ59cGV2X",
          "icon": "discord"
        }
      ]
    }
  },
  "logo": {
    "light": "/assets/logo/onyx_logo.svg",
    "dark": "/assets/logo/onyx_logo_inverted.svg",
    "href": "https://onyx.app/"
  },
  "customization": {
    "css": "/style.css"
  },
  "api": {
    "openapi": [
      "developers/api_reference/openapi.json"
    ]
  },
  "navbar": {
    "primary": {
      "type": "button",
      "label": "Try Onyx Cloud!",
      "href": "https://cloud.onyx.app/?utm_source=docs"
    },
    "links": [
      {
        "label": "onyx-dot-app/onyx",
        "href": "https://github.com/onyx-dot-app/onyx",
        "icon": "github"
      }
    ]
  },
  "footer": {
    "socials": {
      "github": "https://github.com/onyx-dot-app/onyx",
      "twitter": "https://x.com/onyx-dot-app",
      "linkedin": "https://linkedin.com/company/onyx-dot-app"
    }
  },
  "integrations": {
    "gtm": {
      "tagId": "GTM-MFZGFSR5"
    },
    "posthog": {
      "apiKey": "phc_ghlrcfXpgWq9XxZeVMfoJpfaISgFGoXhHYOEcBwdulK",
      "apiHost": "https://us.i.posthog.com"
    }
  },
  "seo": {
    "title": "Onyx AI – Open Source AI Platform for Work",
    "description": "Onyx AI is the open source AI platform for generation, automation, and enterprise search — powered by your team’s data.",
    "metatags": {
      "keywords": "onyx ai, onyx, open source ai, enterprise ai, generative ai platform, enterprise search, ai assistant, knowledge management, danswer"
    }
  }
}