browser-use/docs/docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "aspen",
  "name": "Browser Use",
  "colors": {
    "primary": "#FE750E",
    "light": "#FFF7ED",
    "dark": "#C2410C"
  },
  "favicon": "/favicon.ico",
  "contextual": {
    "options": ["copy", "view"]
  },
  "fonts": {
    "family": "Geist"
  },
  "integrations": {
    "posthog": {
      "apiKey": "phc_F8JMNjW1i2KbGUTaW1unnDdLSPCoyc52SGRU0JecaUh"
    }
  },
  "navigation": {
    "tabs": [
      {
        "tab": "Library",
        "groups": [
          {
            "group": "Get Started",
            "pages": ["introduction", "quickstart", "cli"]
          },
          {
            "group": "Customize",
            "pages": [
              "customize/supported-models",
              "customize/agent-settings",
              "customize/browser-settings",
              "customize/real-browser",
              "customize/output-format",
              "customize/system-prompt",
              "customize/sensitive-data",
              "customize/custom-functions",
              "customize/mcp-client",
              "customize/mcp-server",
              "customize/hooks"
            ]
          },
          {
            "group": "Development",
            "pages": [
              "development/contribution-guide",
              "development/local-setup",
              "development/telemetry",
              "development/observability",
              "development/evaluations",
              "development/roadmap"
            ]
          }
        ]
      },
      {
        "tab": "Cloud API",
        "groups": [
          {
            "group": "Get Started",
            "pages": ["cloud/quickstart", "cloud/search", "cloud/pricing"]
          },
          {
            "group": "Guides",
            "pages": [
              "cloud/implementation",
              "cloud/custom-sdk",
              "cloud/webhooks",
              "cloud/authentication",
              "cloud/n8n-browser-use-integration"
            ]
          },
          {
            "group": "Search API",
            "pages": ["api-reference/simple-search", "api-reference/search-url"]
          },
          {
            "group": "Tasks API",
            "pages": [
              "api-reference/run-task",
              "api-reference/stop-task",
              "api-reference/pause-task",
              "api-reference/resume-task",
              "api-reference/get-task",
              "api-reference/get-task-status",
              "api-reference/list-tasks",
              "api-reference/get-task-media",
              "api-reference/get-task-screenshots",
              "api-reference/get-task-output-file"
            ]
          },
          {
            "group": "Scheduled Tasks API",
            "pages": [
              "api-reference/list-scheduled-tasks",
              "api-reference/create-scheduled-task",
              "api-reference/get-scheduled-task",
              "api-reference/update-scheduled-task",
              "api-reference/delete-scheduled-task"
            ]
          },
          {
            "group": "Browser Profiles API",
            "pages": [
              "api-reference/list-browser-profiles",
              "api-reference/create-browser-profile",
              "api-reference/get-browser-profile",
              "api-reference/update-browser-profile",
              "api-reference/delete-browser-profile"
            ]
          },
          {
            "group": "Files API",
            "pages": ["api-reference/upload-file-presigned-url"]
          },
          {
            "group": "User API",
            "pages": ["api-reference/check-balance", "api-reference/user"]
          },
          {
            "group": "Health Check API",
            "pages": ["api-reference/ping"]
          }
        ]
      },
      {
        "tab": "Cloud API v2",
        "openapi": "https://app.stainless.com/api/spec/documented/browser-use/openapi.documented.yml"
      }
    ]
  },
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg",
    "href": "https://browser-use.com"
  },
  "api": {
    "playground": {
      "display": "interactive"
    },
    "examples": {
      "languages": ["javascript", "curl", "python"],
      "required": true
    }
  },
  "navbar": {
    "links": [
      {
        "label": "Github",
        "href": "https://github.com/browser-use/browser-use"
      },
      {
        "label": "Discord",
        "href": "https://link.browser-use.com/discord"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Browser Use Cloud",
      "href": "https://cloud.browser-use.com"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/browser_use",
      "github": "https://github.com/browser-use/browser-use",
      "linkedin": "https://linkedin.com/company/browser-use"
    }
  }
}