{"id":20555132,"url":"https://github.com/browserbase/js-sdk","last_synced_at":"2025-07-14T21:32:00.915Z","repository":{"id":235892621,"uuid":"791448544","full_name":"browserbase/js-sdk","owner":"browserbase","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-29T10:04:21.000Z","size":289,"stargazers_count":68,"open_issues_count":2,"forks_count":4,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-10-29T12:08:56.272Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/browserbase.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-24T18:29:54.000Z","updated_at":"2024-10-29T04:54:14.000Z","dependencies_parsed_at":"2024-04-24T21:01:41.349Z","dependency_job_id":"ff665bf8-0451-4dd5-8e32-a3f8d1338e25","html_url":"https://github.com/browserbase/js-sdk","commit_stats":null,"previous_names":["browserbase/js-sdk"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserbase%2Fjs-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserbase%2Fjs-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserbase%2Fjs-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserbase%2Fjs-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/browserbase","download_url":"https://codeload.github.com/browserbase/js-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225998802,"owners_count":17557472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T03:16:38.683Z","updated_at":"2024-11-23T04:03:02.383Z","avatar_url":"https://github.com/browserbase.png","language":"TypeScript","readme":"# DEPRECATED. Please refer to v2.0.0 at [browserbase/sdk-node](https://github.com/browserbase/sdk-node)\n\n\u003cp align=\"center\"\u003e\n    \u003cpicture\u003e\n        \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"logo/dark.svg\"/\u003e\n        \u003cimg alt=\"Browserbase logo\" src=\"logo/light.svg\" width=\"300\" /\u003e\n    \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://docs.browserbase.com\"\u003eDocumentation\u003c/a\u003e\n    \u003cspan\u003e\u0026nbsp;·\u0026nbsp;\u003c/span\u003e\n    \u003ca href=\"https://www.browserbase.com/playground\"\u003ePlayground\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\n## Browserbase JS SDK\n\nBrowserbase is the best developer platform to reliably run, manage, and monitor headless browsers.\nLeverage Browserbase to power your automation, test suites, and LLM data retrievals.\n\n## Installation and setup\n\n### 1. Install the SDK:\n\n```bash\nnpm install @browserbasehq/sdk\n```\n\n### 2. Get your Browserbase API Key and Project ID:\n\n- [Create an account](https://www.browserbase.com/sign-up) or [log in to Browserbase](https://www.browserbase.com/sign-in)\n- Copy your API Key and Project ID [from your Settings page](https://www.browserbase.com/settings)\n\n## Usage\n\n```js\nimport { Browserbase } from '@browserbasehq/sdk'\n\n// Init the SDK\nconst browserbase = new Browserbase()\n\n// Load a webpage\nconst rawHtml = await browserbase.load('https://www.browserbase.com')\n\n// Load multiple webpages (returns iterator)\nconst rawHtmls = browserbase.loadURLs([\n  'https://www.browserbase.com',\n  'https://docs.browserbase.com',\n])\n\nfor await (let rawHtml of rawHtmls) {\n  // ...\n}\n\n// Text-only mode\nconst text = await browserbase.load('https://www.browserbase.com', {\n  textContent: true,\n})\n\n// Screenshot (returns bytes)\nconst result = await browserbase.screenshot('https://www.browserbase.com', {\n  textContent: true,\n})\n```\n\n### Vercel AI SDK Integration\n\nInstall the additional dependencies:\n\n```\nnpm install ai openai zod\n```\n\n```js\nimport OpenAI from 'openai'\nimport { Browserbase, BrowserbaseAISDK } from '@browserbasehq/sdk'\nimport {\n  OpenAIStream,\n  StreamingTextResponse,\n  generateText,\n} from 'ai'\n\n// Create new OpenAI client\nconst openai = new OpenAI({\n  apiKey: process.env.OPENAI_API_KEY,\n})\n\n// Init the Browserbase SDK\nconst browserbase = new Browserbase()\n\n// Init the tool\nconst browserTool = BrowserbaseAISDK(browserbase, { textContent: true })\n\n// Load completions\nconst result = await generateText({\n  model: openai.chat('gpt-3.5-turbo'),\n  tools: {\n    browserTool,\n  },\n  prompt: 'What is the weather in San Francisco?',\n})\n```\n\n## Further reading\n\n- [See how to leverage the Session Live View for faster development](https://docs.browserbase.com/features/session-live-view)\n- [Sessions API Reference](https://docs.browserbase.com/reference/api/create-a-session)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserbase%2Fjs-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrowserbase%2Fjs-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserbase%2Fjs-sdk/lists"}