The enterprise edition, including the HIPAA-ready offering, is maintained in a separate private
repository. Contact [email protected] to learn about that edition.
Choose how to get started
Use Oya with an AI assistant
TypeScript SDK for Oya, the HIPAA-compliant agentic browser: start cloud browsers, run playbooks, attach Playwright.
2026-11-14
スター
—
ツール
—
稼働率
—
Install the desktop app, sign in, and connect your assistant
from the app. Oya works with Claude Code, Codex, Cursor and VS Code. People can see the agent's
browser activity and take control when a task needs their attention.
Install the SDK and create an API key at oyabrowser.com. Node.js 20 or
newer is required.
npm install @oya-ai/browser
Set OYA_API_KEY, then run:
import { Oya } from '@oya-ai/browser';
const oya = new Oya();
const browser = await oya.browser.start();
try {
await browser.goto('https://news.ycombinator.com');
console.log(await browser.ask('Summarize the top three stories.'));
} finally {
await browser.stop();
}
With no browser provider configured, start() can use the Oya desktop browser already connected
to your account. To start cloud or self-hosted browsers, configure a provider with
npx @oya-ai/cli init. The SDK and CLI can also use Browserbase, Steel,
Anchor, Browser Use, or a browser you provide. Your application can keep the same SDK calls when
you change providers.
Use the agent reference for setup instructions, available
tools, SDK examples, and MCP configuration. The desktop app can pair with Claude Code, Codex,
Cursor, and VS Code. For remote MCP clients, connect to https://oyabrowser.com/mcp/pool with
your Oya API key.
Run Oya in your own environment
Use the installer to set up a self-hosted instance:
curl -fsSL https://raw.githubusercontent.com/OyadotAI/oya-browser/main/install.sh | sh
For production, choose Docker, Amazon ECS, Kubernetes, or GKE. The deployment guides cover
configuration, storage, upgrades, and operations.
Work in a signed-in browser. Connect the desktop app and reuse logins imported from Chrome,
Arc, Brave, Edge, or Firefox. Set up logins.
Keep a person in control. Watch an agent work, switch between AI Mode and Human Mode, and
keep agent activity in its own tabs.
Turn a successful run into a playbook. Replay repeatable tasks with new inputs, inspect the
generated Playwright module, and export or import workflows.
Playbook details ·
Replay benchmark.
Choose where browsers run. Use Oya Cloud, your own deployment, supported browser providers,
or a browser you provide. Why route through Oya?.
Operate with governance controls. Self-hosted community deployments include host egress
rules and a tamper-evident audit trail. See the control evidence and
trust center.
For contributors
Oya is made up of the browser, control plane, console, SDK, and CLI. Start with the architecture
map, then read the guide for the part you plan to change.
Requirements and commands vary by project area. See Working in this repository for
the conventions and complete command list. To install dependencies across the workspace:
npm run setup
Common checks:
npm run lint
npm run format:check
npm test
The full test command builds the SDK and runs the server, CLI, package, and script suites. For
changes in the UI or browser app, run the checks listed in that part's package.json and
architecture guide as well.
The SDK and CLI are MIT licensed. The rest of the project is available under the Sustainable Use
License. See LICENSE.md for permitted use, self-hosting terms, and commercial
licensing details.