> ## Documentation Index
> Fetch the complete documentation index at: https://docs-preview.webcompute.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Use the Webcompute REST API for direct managed browser lifecycle, resources, runtime status, execution, and quick actions.

Use REST when your platform owns transport and orchestration directly. TypeScript applications should usually start with the SDK.

Base URL:

```text theme={null}
https://api.webcompute.dev
```

Authentication uses bearer API keys on all non-public endpoints:

```bash theme={null}
curl https://api.webcompute.dev/v1/browsers \
  -H "Authorization: Bearer $WEBCOMPUTE_API_KEY"
```

## Public endpoint groups

* Health: `/health`
* Browser lifecycle: `/v1/browsers`
* Browser status and pages: `/v1/browsers/{id}/status`, `/v1/browsers/{id}/pages`
* Browser-code execution: `/v1/browsers/{id}/playwright/execute`
* Captcha and blockers: `/v1/browsers/{id}/captcha/resolve`
* Resources: files, downloads, dialogs, permissions, recordings, events
* Quick actions: `/v1/scrape`, `/v1/screenshot`, `/v1/pdf`

## OpenAPI source

The public API reference is backed by `docs/openapi/webcompute.json`. The Gateway extraction command is:

```bash theme={null}
pnpm nx run @webcompute/gateway:extract-openapi
```

Publish curated API-reference updates by copying the extracted spec into `docs/openapi/webcompute.json` before deployment.

## SDK-first guidance

Prefer the SDK when you are building in TypeScript. It wraps authentication, retries, browser resource helpers, download saving, recording downloads, and error mapping.