# Webcompute

> Run browser agents from the terminal and build them into production workflows with a managed, observable browser runtime.

## Docs

- [Run tasks with web agent](https://docs-preview.webcompute.dev/agent-workflows/cli-agent.md): Use the web agent CLI for delegated browser tasks with model profiles, domain boundaries, structured output, secrets, approvals, and live inspection.
- [Long-running tasks](https://docs-preview.webcompute.dev/agent-workflows/long-running-tasks.md): Design browser-agent workflows with phases, budgets, retries, status, and blocker handling.
- [Mix agent and code](https://docs-preview.webcompute.dev/agent-workflows/mixing-agent-and-code.md): Combine browser-agent steps with deterministic setup, validation, persistence, retries, and exact browser control.
- [Agent workflows](https://docs-preview.webcompute.dev/agent-workflows/overview.md): Build browser-agent workflows with the SDK after proving a task with the CLI.
- [Policies and approvals](https://docs-preview.webcompute.dev/agent-workflows/policies-and-approvals.md): Constrain browser-agent runs with domain policy and handle high-impact actions with approvals.
- [SDK quickstart](https://docs-preview.webcompute.dev/agent-workflows/sdk-quickstart.md): Build a browser-agent workflow with the TypeScript SDK, domain policy, approvals, and result handling.
- [Secrets and user input](https://docs-preview.webcompute.dev/agent-workflows/secrets-and-user-input.md): Provide env-backed secrets and scoped variables to browser-agent runs without putting credentials in prompts.
- [Streaming progress](https://docs-preview.webcompute.dev/agent-workflows/streaming-progress.md): Stream browser-agent run events from the SDK and map them to product progress states.
- [Structured output](https://docs-preview.webcompute.dev/agent-workflows/structured-output.md): Ask browser-agent runs to return validated JSON output for product workflows.
- [API authentication](https://docs-preview.webcompute.dev/api-reference/authentication.md): Authenticate Webcompute REST API requests with bearer API keys and environment variables.
- [Accept a browser JavaScript dialog](https://docs-preview.webcompute.dev/api-reference/browsers/accept-a-browser-javascript-dialog.md)
- [Close a browser](https://docs-preview.webcompute.dev/api-reference/browsers/close-a-browser.md)
- [Create a new browser](https://docs-preview.webcompute.dev/api-reference/browsers/create-a-new-browser.md)
- [Delete a browser file](https://docs-preview.webcompute.dev/api-reference/browsers/delete-a-browser-file.md)
- [Dismiss a browser JavaScript dialog](https://docs-preview.webcompute.dev/api-reference/browsers/dismiss-a-browser-javascript-dialog.md)
- [Execute browser-control code](https://docs-preview.webcompute.dev/api-reference/browsers/execute-browser-control-code.md): Runs the current Playwright-backed browser-control API against a ready managed browser. Use this when deterministic browser control is the right tool.
- [Get a browser page](https://docs-preview.webcompute.dev/api-reference/browsers/get-a-browser-page.md)
- [Get a browser recording segment frame](https://docs-preview.webcompute.dev/api-reference/browsers/get-a-browser-recording-segment-frame.md)
- [Get browser details](https://docs-preview.webcompute.dev/api-reference/browsers/get-browser-details.md)
- [Get browser download metadata](https://docs-preview.webcompute.dev/api-reference/browsers/get-browser-download-metadata.md)
- [Get browser file metadata](https://docs-preview.webcompute.dev/api-reference/browsers/get-browser-file-metadata.md)
- [Get browser recording segment manifest](https://docs-preview.webcompute.dev/api-reference/browsers/get-browser-recording-segment-manifest.md)
- [Get browser recording summary](https://docs-preview.webcompute.dev/api-reference/browsers/get-browser-recording-summary.md)
- [Get lightweight browser status](https://docs-preview.webcompute.dev/api-reference/browsers/get-lightweight-browser-status.md)
- [List browser downloads](https://docs-preview.webcompute.dev/api-reference/browsers/list-browser-downloads.md)
- [List browser events](https://docs-preview.webcompute.dev/api-reference/browsers/list-browser-events.md)
- [List browser files](https://docs-preview.webcompute.dev/api-reference/browsers/list-browser-files.md)
- [List browser JavaScript dialogs](https://docs-preview.webcompute.dev/api-reference/browsers/list-browser-javascript-dialogs.md)
- [List browser pages](https://docs-preview.webcompute.dev/api-reference/browsers/list-browser-pages.md)
- [List browser recording segment events](https://docs-preview.webcompute.dev/api-reference/browsers/list-browser-recording-segment-events.md)
- [List browser recording segments](https://docs-preview.webcompute.dev/api-reference/browsers/list-browser-recording-segments.md)
- [List browsers](https://docs-preview.webcompute.dev/api-reference/browsers/list-browsers.md)
- [Mint live browser capabilities](https://docs-preview.webcompute.dev/api-reference/browsers/mint-live-browser-capabilities.md)
- [Reset browser permissions](https://docs-preview.webcompute.dev/api-reference/browsers/reset-browser-permissions.md)
- [Resolve CAPTCHA on the current browser page](https://docs-preview.webcompute.dev/api-reference/browsers/resolve-captcha-on-the-current-browser-page.md)
- [Resume a stopped browser](https://docs-preview.webcompute.dev/api-reference/browsers/resume-a-stopped-browser.md)
- [Retrieve browser download content](https://docs-preview.webcompute.dev/api-reference/browsers/retrieve-browser-download-content.md)
- [Retrieve browser file content](https://docs-preview.webcompute.dev/api-reference/browsers/retrieve-browser-file-content.md)
- [Scrape content using a persistent browser](https://docs-preview.webcompute.dev/api-reference/browsers/scrape-content-using-a-persistent-browser.md)
- [Stage a browser file](https://docs-preview.webcompute.dev/api-reference/browsers/stage-a-browser-file.md)
- [Stop a running browser](https://docs-preview.webcompute.dev/api-reference/browsers/stop-a-running-browser.md)
- [Update browser permissions](https://docs-preview.webcompute.dev/api-reference/browsers/update-browser-permissions.md)
- [Gateway health check](https://docs-preview.webcompute.dev/api-reference/health/gateway-health-check.md)
- [API overview](https://docs-preview.webcompute.dev/api-reference/overview.md): Use the Webcompute REST API for direct managed browser lifecycle, resources, runtime status, execution, and quick actions.
- [Generate PDF from a URL (ephemeral browser)](https://docs-preview.webcompute.dev/api-reference/quick-actions/generate-pdf-from-a-url-ephemeral-browser.md)
- [Scrape a URL (ephemeral browser)](https://docs-preview.webcompute.dev/api-reference/quick-actions/scrape-a-url-ephemeral-browser.md)
- [Screenshot a URL (ephemeral browser)](https://docs-preview.webcompute.dev/api-reference/quick-actions/screenshot-a-url-ephemeral-browser.md)
- [Authentication](https://docs-preview.webcompute.dev/authentication.md): Authenticate Webcompute CLI, SDK, MCP, REST, and browser-agent runs with Webcompute API keys and env-backed secrets.
- [Grants.gov opportunities](https://docs-preview.webcompute.dev/examples/grants-gov-opportunities.md): Run a browser agent that searches Grants.gov and returns active opportunity fields.
- [Guided SDK workflow](https://docs-preview.webcompute.dev/examples/guided-sdk-workflow.md): Build a production-shaped browser-agent workflow with setup, web.agent(), validation, persistence, and review.
- [Examples](https://docs-preview.webcompute.dev/examples/index.md): Choose examples by capability: agent research, structured output, downloads, debugging, SDK workflows, MCP hosts, and production patterns.
- [MCP browser task](https://docs-preview.webcompute.dev/examples/mcp-browser-task.md): Give a coding-agent host Webcompute browser tools through MCP and run an observed browser task.
- [NHTSA recall lookup](https://docs-preview.webcompute.dev/examples/nhtsa-recall-lookup.md): Run a browser agent that researches public vehicle recalls without entering a real VIN.
- [Procurement research](https://docs-preview.webcompute.dev/examples/procurement-research.md): Run a browser agent that searches public procurement opportunities and returns scoped capture fields.
- [Public report download](https://docs-preview.webcompute.dev/examples/public-report-download.md): Run a browser agent that confirms a public PDF is reachable and captures download evidence.
- [REST quick actions](https://docs-preview.webcompute.dev/examples/rest-quick-actions.md): Use REST quick actions to scrape a page, capture a screenshot, or render a PDF without managing a browser session.
- [SEC EDGAR filing research](https://docs-preview.webcompute.dev/examples/sec-edgar-company-filings.md): Run a browser agent that searches SEC EDGAR and returns structured filing metadata.
- [Prompt gallery](https://docs-preview.webcompute.dev/examples/web-agent-prompts.md): Use delegated Webcompute browser prompts with exact URLs, output fields, result counts, safety boundaries, and inspection guidance.
- [Choose your path](https://docs-preview.webcompute.dev/get-started/choose-your-path.md): Choose the right Webcompute surface for delegated agent tasks, exact Playwright control, coding-agent hosts, REST, CDP, and quick actions.
- [First real task](https://docs-preview.webcompute.dev/get-started/first-real-task.md): Run a scoped browser-agent task with fields, JSON output, safety boundaries, and blocker guidance.
- [Model setup](https://docs-preview.webcompute.dev/get-started/model-setup.md): Configure a reusable model profile for web agent browsing from the CLI and optional MCP run_web_agent.
- [What Webcompute returns](https://docs-preview.webcompute.dev/get-started/what-webcompute-returns.md): Compare final answers, structured output, Playwright return values, observations, status, artifacts, Debug UI URLs, CDP URLs, and errors across Webcompute surfaces.
- [Infrastructure for web agents](https://docs-preview.webcompute.dev/index.md): Run browser work for agents and apps with Playwright control, managed sessions, live inspection, and production guardrails.
- [Installation](https://docs-preview.webcompute.dev/installation.md): Install the Webcompute CLI for browser-agent runs and add the TypeScript SDK when you are ready to build workflows.
- [CDP and browser frameworks](https://docs-preview.webcompute.dev/integrations/cdp-and-browser-frameworks.md): Attach external browser tooling through CDP and understand when Webcompute observations are available.
- [CLI operations](https://docs-preview.webcompute.dev/integrations/cli-operations.md): Use the Webcompute CLI for browser operations, MCP setup, plugins, model profiles, diagnostics, and updates.
- [For coding agents](https://docs-preview.webcompute.dev/integrations/coding-agents.md): Give Codex, Claude Code, Cursor, OpenCode, Devin, or another MCP host a managed browser with Playwright execution, observations, status, artifacts, and cleanup guidance.
- [MCP](https://docs-preview.webcompute.dev/integrations/mcp.md): Configure Webcompute MCP tools for coding-agent browser lifecycle, execution, and optional delegated agent mode.
- [Integrations](https://docs-preview.webcompute.dev/integrations/overview.md): Connect Webcompute to coding agents, REST clients, browser frameworks, and CLI operator workflows.
- [REST API](https://docs-preview.webcompute.dev/integrations/rest-api.md): Use Webcompute over HTTP when a platform, worker, or non-TypeScript service owns browser orchestration.
- [Artifacts and downloads](https://docs-preview.webcompute.dev/observe-and-debug/artifacts-and-downloads.md): Capture downloaded files, public reports, PDFs, and evidence from browser-agent workflows.
- [Blockers and CAPTCHA](https://docs-preview.webcompute.dev/observe-and-debug/blockers-and-captcha.md): Handle blocked browser-agent runs by returning evidence, status, and review paths instead of overclaiming access.
- [Errors](https://docs-preview.webcompute.dev/observe-and-debug/errors.md): Handle browser-agent, SDK, CLI, MCP, and runtime errors with status, evidence, and next actions.
- [Live browser sessions](https://docs-preview.webcompute.dev/observe-and-debug/live-browser-sessions.md): Open trusted Debug UI links to inspect live Webcompute browser-agent runs.
- [Observe and debug](https://docs-preview.webcompute.dev/observe-and-debug/overview.md): Inspect browser-agent runs with live sessions, recordings, artifacts, status, events, blockers, and errors.
- [Recordings](https://docs-preview.webcompute.dev/observe-and-debug/recordings.md): Record browser-agent runs and use replay evidence when a run needs review.
- [Status, events, and logs](https://docs-preview.webcompute.dev/observe-and-debug/status-events-and-logs.md): Use runtime status, event streams, and concise logs to understand browser-agent progress.
- [Production architecture](https://docs-preview.webcompute.dev/production/architecture.md): Design browser-agent and Playwright workflows as inspectable jobs with policy, retries, artifacts, and cleanup.
- [Blockers and CAPTCHA](https://docs-preview.webcompute.dev/production/blockers-and-captcha.md): Handle blocker and CAPTCHA states with status, evidence, approvals, and human review instead of overpromising access.
- [Errors and retries](https://docs-preview.webcompute.dev/production/errors-and-retries.md): Design retries around Webcompute error classes, browser status, blockers, policy decisions, and redacted logs.
- [Limits and retention](https://docs-preview.webcompute.dev/production/limits-and-retention.md): Design browser jobs around documented limits, account-specific quotas, artifact size caps, and cleanup.
- [Observability](https://docs-preview.webcompute.dev/production/observability.md): Connect browser status, execution logs, events, recordings, artifacts, and app logs into an inspectable production workflow.
- [Policy and proxy](https://docs-preview.webcompute.dev/production/policy-and-proxy.md): Use browser policy for scope and proxy configuration for egress without confusing the two controls.
- [Security and secrets](https://docs-preview.webcompute.dev/production/security-and-secrets.md): Handle API keys, provider keys, Debug UI URLs, CDP URLs, policies, and user-provided secrets safely.
- [Quickstart](https://docs-preview.webcompute.dev/quickstart.md): Install Webcompute, configure model access, run a real browser task, and inspect the managed browser run.
- [Agent contract](https://docs-preview.webcompute.dev/reference/agent-contract.md): Reference the operational contract agents should follow when using Webcompute browser tools.
- [CLI command reference](https://docs-preview.webcompute.dev/reference/cli-command-reference.md): Reference every Webcompute CLI command, argument, option, and operational caveat.
- [Environment variables](https://docs-preview.webcompute.dev/reference/environment-variables.md): Reference Webcompute environment variables for SDK, CLI, MCP, model profiles, local development, and release/runtime behavior.
- [Error codes](https://docs-preview.webcompute.dev/reference/error-codes.md): Understand Webcompute SDK errors, Gateway error codes, browser-server failures, retry behavior, and browser-code execution outcomes.
- [Glossary](https://docs-preview.webcompute.dev/reference/glossary.md): Definitions for Webcompute browser infrastructure, runtime, tooling, observations, artifacts, CDP, MCP, and agent harness terms.
- [Limits](https://docs-preview.webcompute.dev/reference/limits.md): Reference practical Webcompute limits for browsers, Playwright execution, observations, variables, events, quick actions, MCP, and agent workflows.
- [MCP tool reference](https://docs-preview.webcompute.dev/reference/mcp-tool-reference.md): Reference Webcompute MCP runtime and agent tools, schemas, defaults, setup behavior, environment variables, and limitations.
- [Policy reference](https://docs-preview.webcompute.dev/reference/policy-reference.md): Reference Webcompute browser policy fields, validation rules, tips, private-access controls, downloads, uploads, and approvals.
- [Proxy reference](https://docs-preview.webcompute.dev/reference/proxy-reference.md): Reference custom proxy support across SDK, CLI, REST, MCP, quick actions, browser creation, and web-agent workflows.
- [SDK agent reference](https://docs-preview.webcompute.dev/reference/sdk-agent-reference.md): Reference web.agent(), agent configuration, model routes, sessions, streaming events, confirmations, and structured output.
- [SDK browser reference](https://docs-preview.webcompute.dev/reference/sdk-browser-reference.md): Reference managed browser lifecycle methods, browser handles, Playwright execution, capture options, signed URLs, and lifecycle responses.
- [SDK quick actions reference](https://docs-preview.webcompute.dev/reference/sdk-quick-actions-reference.md): Reference deterministic SDK quick actions for scrape, screenshot, and PDF generation, including options, responses, policy, and proxy support.
- [TypeScript SDK reference](https://docs-preview.webcompute.dev/reference/sdk-reference.md): Reference the Webcompute TypeScript SDK entry point, client configuration, errors, warnings, and exported symbols.
- [SDK resources reference](https://docs-preview.webcompute.dev/reference/sdk-resources-reference.md): Reference browser-scoped SDK resources for files, downloads, dialogs, permissions, recordings, events, pages, and CAPTCHA.
- [Playwright execution](https://docs-preview.webcompute.dev/runtime-concepts/browser-control.md): Run deterministic Playwright code against managed browsers and understand when to use it instead of delegated agent control.
- [Browser lifecycle](https://docs-preview.webcompute.dev/runtime-concepts/browser-lifecycle.md): Create, inspect, stop, resume, and close managed Webcompute browsers.
- [Browser resources](https://docs-preview.webcompute.dev/runtime-concepts/browser-resources.md): Use pages, files, downloads, dialogs, permissions, recordings, events, and artifacts around managed browser runs.
- [Managed browsers](https://docs-preview.webcompute.dev/runtime-concepts/managed-browsers.md): Understand browser sessions, lifecycle, capabilities, resources, and inspection across Webcompute surfaces.
- [Observations](https://docs-preview.webcompute.dev/runtime-concepts/observations.md): Understand bounded page evidence returned after Webcompute Playwright execution steps.
- [Quick actions](https://docs-preview.webcompute.dev/runtime-concepts/quick-actions.md): Use scrape, screenshot, and PDF quick actions when one URL-level browser operation is enough.
- [Security model](https://docs-preview.webcompute.dev/runtime-concepts/security-model.md): Use domain policy, approvals, secret variables, and signed capability handling for browser-agent workflows.

## OpenAPI Specs

- [webcompute](https://docs-preview.webcompute.dev/openapi/webcompute.json)