onyx-dot-app/documentation
1
0
Fork 0
mirror of https://github.com/onyx-dot-app/documentation.git synced 2026-07-25 05:35:37 -04:00
Code Issues 17 Packages Projects Releases Wiki Activity
Files
main
documentation/docs.json
T

664 lines
26 KiB
JSON
Raw Permalink Blame History

{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Onyx Documentation",
"colors": {
"primary": "#0069ED",
"light": "#4D9CFF",
"dark": "#0050B4"
},
"favicon": "assets/logo/onyx_favicon.svg",
"banner": {
"content": "**Upcoming change:** Onyx is moving to group-based permissions. Curator and Global Curator roles will be removed. [See what's changing](/admins/permissions/whats_changing)",
"dismissible": true
},
"navigation": {
"tabs": [
{
"tab": "Overview",
"icon": "house",
"pages": [
{
"group": "Getting Started",
"pages": ["welcome", "overview/getting_started/quickstart"]
},
{
"group": "Core Features",
"pages": [
"overview/core_features/chat",
"overview/core_features/internal_search",
"overview/core_features/connectors",
"overview/core_features/agents",
"overview/core_features/actions",
"overview/core_features/web_search",
"overview/core_features/code_interpreter",
"overview/core_features/image_generation",
"overview/core_features/voice_mode",
{
"group": "Craft",
"icon": "hammer",
"pages": [
"overview/core_features/craft",
"overview/core_features/craft_skills",
"overview/core_features/craft_apps",
"overview/core_features/craft_scheduled_tasks"
]
},
"overview/core_features/coding_agent"
]
},
{
"group": "Onyx Anywhere",
"pages": [
"overview/onyx_anywhere/desktop_app",
"overview/onyx_anywhere/chrome_extension",
"overview/onyx_anywhere/website_widget",
"overview/onyx_anywhere/slack",
"overview/onyx_anywhere/discord_bot",
"overview/onyx_anywhere/mcp_server",
"overview/onyx_anywhere/cli",
"overview/onyx_anywhere/mobile_app"
]
},
{
"group": "Miscellaneous",
"pages": [
"overview/miscellaneous/open_source_statement",
"overview/getting_started/use_cases",
"overview/getting_started/faq",
"overview/miscellaneous/contact_us"
]
}
]
},
{
"tab": "Deployment",
"icon": "server",
"pages": [
{
"group": "Getting Started",
"pages": [
"deployment/overview",
"deployment/getting_started/quickstart",
"deployment/getting_started/resourcing"
]
},
{
"group": "Deploy Locally",
"pages": [
"deployment/local/docker",
"deployment/local/kubernetes",
"deployment/local/terraform",
"deployment/local/opensearch"
]
},
{
"group": "Craft",
"icon": "hammer",
"pages": [
"deployment/local/craft",
"deployment/local/craft_kubernetes",
"deployment/local/craft_docker_compose"
]
},
{
"group": "Onyx Anywhere",
"pages": [
"deployment/local/desktop_app",
"deployment/configuration/chrome_extension",
"deployment/configuration/website_widget",
"deployment/configuration/mcp_server"
]
},
{
"group": "Deploy on 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",
"deployment/authentication/sso_providers"
]
},
{
"group": "Miscellaneous",
"pages": [
"deployment/configuration/configuration",
"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/enterprise_edition"
]
},
{
"group": "Language Models",
"pages": [
"admins/ai_models/overview",
{
"group": "Supported Providers",
"icon": "microchip",
"pages": [
"admins/ai_models/openai",
"admins/ai_models/anthropic",
"admins/ai_models/ollama",
"admins/ai_models/lm_studio",
"admins/ai_models/azure_openai",
"admins/ai_models/bedrock",
"admins/ai_models/google_ai",
"admins/ai_models/openrouter",
"admins/ai_models/bifrost",
"admins/ai_models/litellm_proxy",
"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/drupal_wiki",
"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": "Managing Features",
"pages": [
"admins/managing_features/chat",
{
"group": "RAG and Search",
"icon": "magnifying-glass",
"pages": [
"admins/managing_features/connectors_link",
"admins/advanced_configs/search_configs",
"admins/managing_features/document_sets",
"admins/advanced_configs/opensearch_document_index_migration"
]
},
"admins/agents/overview",
{
"group": "Actions",
"icon": "play",
"pages": ["admins/actions/mcp", "admins/actions/openapi"]
},
"admins/actions/web_search",
"admins/actions/code_interpreter",
"admins/actions/image_generation",
"admins/actions/voice_mode",
{
"group": "Craft",
"icon": "hammer",
"pages": [
"admins/managing_features/craft",
"admins/managing_features/craft_skills",
"admins/managing_features/craft_apps"
]
},
"admins/actions/coding_agent"
]
},
{
"group": "Access Control",
"pages": [
"admins/user_management/users_and_groups",
"admins/permissions/whats_changing",
"deployment/authentication/scim",
"admins/user_management/api_keys"
]
},
{
"group": "Advanced Configs",
"pages": [
"admins/advanced_configs/spending_limits",
"admins/advanced_configs/white_labeling",
"admins/advanced_configs/llm_access_controls",
"admins/advanced_configs/hook_extensions",
"admins/advanced_configs/tracing",
"admins/getting_started/slack_bot_setup",
"admins/miscellaneous/discord_bot"
]
},
{
"group": "Auditing",
"pages": [
"admins/auditing/audit_logs",
"admins/analytics/overview",
"admins/analytics/query_history",
"admins/analytics/custom_analytics"
]
},
{
"group": "Plans & Billing",
"pages": [
"admins/billing/overview",
"admins/billing/subscribing",
"admins/billing/manage",
"admins/billing/troubleshooting"
]
},
{
"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_new_guide",
"developers/guides/index_files_ingestion_api",
"developers/guides/create_connector"
]
},
{
"group": "API Reference",
"pages": [
{
"group": "Chat",
"icon": "comment",
"pages": [
"developers/api_reference/chat/create_new_chat_session",
"developers/api_reference/chat/handle_send_chat_message",
"developers/api_reference/chat/seed_chat",
"developers/api_reference/chat/stop_chat_session",
"developers/api_reference/chat/search_chats",
"developers/api_reference/chat/get_chat_session",
"developers/api_reference/chat/get_user_chat_sessions",
"developers/api_reference/chat/fetch_chat_file",
"developers/api_reference/chat/delete_chat_session_by_id",
"developers/api_reference/chat/delete_all_chat_sessions"
]
},
{
"group": "Search",
"icon": "magnifying-glass",
"pages": [
"developers/api_reference/search/handle_search_request",
"developers/api_reference/search/execute_web_search",
"developers/api_reference/search/execute_web_search_lite",
"developers/api_reference/search/execute_open_urls"
]
},
{
"group": "Agents",
"icon": "robot",
"pages": [
"developers/api_reference/agents/create_persona",
"developers/api_reference/agents/get_persona",
"developers/api_reference/agents/update_persona",
"developers/api_reference/agents/delete_persona",
"developers/api_reference/agents/get_agents_paginated",
"developers/api_reference/agents/get_agents_admin_paginated",
"developers/api_reference/agents/list_personas_admin",
"developers/api_reference/agents/undelete_persona"
]
},
{
"group": "Actions",
"icon": "play",
"pages": [
"developers/api_reference/actions/create_custom_tool",
"developers/api_reference/actions/update_custom_tool",
"developers/api_reference/actions/delete_custom_tool",
"developers/api_reference/actions/validate_tool",
"developers/api_reference/actions/list_tools",
"developers/api_reference/actions/list_openapi_tools",
"developers/api_reference/actions/get_custom_tool"
]
},
{
"group": "Connectors & Credentials",
"icon": "plug",
"pages": [
{
"group": "Connectors",
"pages": [
"developers/api_reference/files_connectors/create_connector_from_model",
"developers/api_reference/files_connectors/get_connectors_by_credential",
"developers/api_reference/files_connectors/get_connectors",
"developers/api_reference/files_connectors/get_connector_by_id",
"developers/api_reference/files_connectors/get_basic_connector_indexing_status",
"developers/api_reference/files_connectors/get_connector_status",
"developers/api_reference/files_connectors/get_currently_failed_indexing_status",
"developers/api_reference/files_connectors/get_connector_indexing_status",
"developers/api_reference/files_connectors/connector_run_once",
"developers/api_reference/files_connectors/upload_files_api",
"developers/api_reference/files_connectors/list_connector_files",
"developers/api_reference/files_connectors/update_connector_files",
"developers/api_reference/files_connectors/delete_connector_by_id",
"developers/api_reference/files_connectors/create_deletion_attempt_for_connector_id",
"developers/api_reference/files_connectors/get_indexed_sources",
"developers/api_reference/files_connectors/get_cc_pair_full_info",
"developers/api_reference/files_connectors/get_cc_pair_index_attempts",
"developers/api_reference/files_connectors/get_cc_pair_indexing_errors",
"developers/api_reference/files_connectors/update_cc_pair_status",
"developers/api_reference/files_connectors/prune_cc_pair",
"developers/api_reference/files_connectors/get_cc_source_full_info",
"developers/api_reference/files_connectors/get_docs_by_connector_credential_pair"
]
},
{
"group": "Credentials",
"pages": [
"developers/api_reference/files_connectors/list_credentials_admin",
"developers/api_reference/files_connectors/list_credentials",
"developers/api_reference/files_connectors/get_credential_by_id",
"developers/api_reference/files_connectors/create_credential_from_model",
"developers/api_reference/files_connectors/create_credential_with_private_key",
"developers/api_reference/files_connectors/update_credential_from_model",
"developers/api_reference/files_connectors/update_credential_data",
"developers/api_reference/files_connectors/update_credential_private_key",
"developers/api_reference/files_connectors/delete_credential_by_id",
"developers/api_reference/files_connectors/delete_credential_by_id_admin",
"developers/api_reference/files_connectors/force_delete_credential_by_id",
"developers/api_reference/files_connectors/swap_credentials_for_connector",
"developers/api_reference/files_connectors/associate_credential_to_connector",
"developers/api_reference/files_connectors/dissociate_credential_from_connector"
]
}
]
},
{
"group": "Projects & Files",
"icon": "folder",
"pages": [
"developers/api_reference/projects/get_projects",
"developers/api_reference/projects/create_project",
"developers/api_reference/projects/get_project",
"developers/api_reference/projects/update_project",
"developers/api_reference/projects/delete_project",
"developers/api_reference/projects/get_project_details",
"developers/api_reference/projects/get_project_instructions",
"developers/api_reference/projects/upsert_project_instructions",
"developers/api_reference/projects/get_files_in_project",
"developers/api_reference/projects/get_chat_session_project_files",
"developers/api_reference/projects/upload_user_files",
"developers/api_reference/projects/get_user_file_statuses",
"developers/api_reference/projects/get_user_file",
"developers/api_reference/projects/delete_user_file",
"developers/api_reference/projects/link_user_file_to_project",
"developers/api_reference/projects/unlink_user_file_from_project"
]
},
{
"group": "Ingestion API",
"icon": "file-arrow-up",
"pages": [
"developers/api_reference/ingestion/get_ingestion_docs",
"developers/api_reference/ingestion/upsert_ingestion_doc",
"developers/api_reference/ingestion/delete_ingestion_doc"
]
},
{
"group": "User Management",
"icon": "user",
"pages": [
"developers/api_reference/user_management/get_auth_type",
"developers/api_reference/user_management/verify_user_logged_in",
"developers/api_reference/user_management/get_user_role",
"developers/api_reference/user_management/set_user_role",
"developers/api_reference/user_management/list_all_users_basic_info",
"developers/api_reference/user_management/list_all_users",
"developers/api_reference/user_management/list_invited_users",
"developers/api_reference/user_management/list_accepted_users",
"developers/api_reference/user_management/bulk_invite_users",
"developers/api_reference/user_management/remove_invited_user",
"developers/api_reference/user_management/activate_user_api",
"developers/api_reference/user_management/deactivate_user_api",
"developers/api_reference/user_management/delete_user"
]
},
{
"group": "Token Limits",
"icon": "gauge",
"pages": [
"developers/api_reference/miscellaneous/get_global_token_limit_settings",
"developers/api_reference/miscellaneous/create_global_token_limit_settings",
"developers/api_reference/miscellaneous/update_token_limit_settings",
"developers/api_reference/miscellaneous/delete_token_limit_settings"
]
},
{
"group": "Miscellaneous",
"icon": "list",
"pages": [
"developers/api_reference/miscellaneous/healthcheck",
"developers/api_reference/miscellaneous/get_version",
"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/craft",
"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": "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": {
"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 \u2014 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"
}
},
"contextual": {
"options": []
}
}
Reference in New Issue View Git Blame Copy Permalink