Tools

Browsersteuerungs-API

Für Einrichtung, Konfiguration und Fehlerbehebung siehe Browser. Diese Seite ist die Referenz für die lokale Control-HTTP-API, die openclaw browser CLI und Scripting-Muster (Snapshots, Refs, Wartevorgänge, Debug-Flows).

Control-API (optional)

Nur für lokale Integrationen stellt der Gateway eine kleine Loopback-HTTP-API bereit:

Status/Start/Stopp: GET /, POST /start, POST /stop
Tabs: GET /tabs, POST /tabs/open, POST /tabs/focus, DELETE /tabs/:targetId
Snapshot/Screenshot: GET /snapshot, POST /screenshot
Aktionen: POST /navigate, POST /act
Hooks: POST /hooks/file-chooser, POST /hooks/dialog
Downloads: POST /download, POST /wait/download
Berechtigungen: POST /permissions/grant
Debugging: GET /console, POST /pdf
Debugging: GET /errors, GET /requests, POST /trace/start, POST /trace/stop, POST /highlight
Netzwerk: POST /response/body
Status: GET /cookies, POST /cookies/set, POST /cookies/clear
Status: GET /storage/:kind, POST /storage/:kind/set, POST /storage/:kind/clear
Einstellungen: POST /set/offline, POST /set/headers, POST /set/credentials, POST /set/geolocation, POST /set/media, POST /set/timezone, POST /set/locale, POST /set/device

Alle Endpunkte akzeptieren ?profile=<name>. POST /start?headless=true fordert einen einmaligen Headless-Start für lokale verwaltete Profile an, ohne die persistierte Browser-Konfiguration zu ändern; Attach-only-, Remote-CDP- und Existing-Session-Profile lehnen diese Überschreibung ab, weil OpenClaw diese Browser-Prozesse nicht startet.

Wenn Shared-Secret-Gateway-Authentifizierung konfiguriert ist, erfordern Browser-HTTP-Routen ebenfalls Authentifizierung:

Authorization: Bearer <gateway token>
x-openclaw-password: <gateway password> oder HTTP-Basic-Authentifizierung mit diesem Passwort

Hinweise:

Diese eigenständige Loopback-Browser-API verarbeitet keine Trusted-Proxy- oder Tailscale-Serve-Identitätsheader.
Wenn gateway.auth.mode auf none oder trusted-proxy gesetzt ist, übernehmen diese Loopback-Browser- Routen diese identitätstragenden Modi nicht; halten Sie sie ausschließlich über Loopback erreichbar.

`/act`-Fehlervertrag

POST /act verwendet eine strukturierte Fehlerantwort für Validierungsfehler auf Routenebene und Policy-Fehler:

{ "error": "<message>", "code": "ACT_*" }

Aktuelle code-Werte:

ACT_KIND_REQUIRED (HTTP 400): kind fehlt oder wird nicht erkannt.
ACT_INVALID_REQUEST (HTTP 400): Aktions-Payload konnte nicht normalisiert oder validiert werden.
ACT_SELECTOR_UNSUPPORTED (HTTP 400): selector wurde mit einer nicht unterstützten Aktionsart verwendet.
ACT_EVALUATE_DISABLED (HTTP 403): evaluate (oder wait --fn) ist durch die Konfiguration deaktiviert.
ACT_TARGET_ID_MISMATCH (HTTP 403): targetId auf oberster Ebene oder in einem Batch steht im Konflikt mit dem Request-Ziel.
ACT_EXISTING_SESSION_UNSUPPORTED (HTTP 501): Die Aktion wird für Existing-Session-Profile nicht unterstützt.

Andere Laufzeitfehler können weiterhin { "error": "<message>" } ohne ein code-Feld zurückgeben.

Playwright-Anforderung

Einige Funktionen (Navigate/Act/AI-Snapshot/Rollen-Snapshot, Element-Screenshots, PDF) erfordern Playwright. Wenn Playwright nicht installiert ist, geben diese Endpunkte einen klaren 501-Fehler zurück.

Was ohne Playwright weiterhin funktioniert:

ARIA-Snapshots
Rollenartige Accessibility-Snapshots (--interactive, --compact, --depth, --efficient), wenn ein pro Tab verfügbarer CDP-WebSocket vorhanden ist. Dies ist ein Fallback für Inspektion und Ref-Ermittlung; Playwright bleibt die primäre Aktions-Engine.
Seiten-Screenshots für den verwalteten openclaw-Browser, wenn ein pro Tab verfügbarer CDP- WebSocket vorhanden ist
Seiten-Screenshots für existing-session- / Chrome-MCP-Profile
existing-session-Ref-basierte Screenshots (--ref) aus der Snapshot-Ausgabe

Was weiterhin Playwright benötigt:

navigate
act
AI-Snapshots, die vom nativen AI-Snapshot-Format von Playwright abhängen
CSS-Selektor-Element-Screenshots (--element)
vollständiger Browser-PDF-Export

Element-Screenshots lehnen außerdem --full-page ab; die Route gibt fullPage is not supported for element screenshots zurück.

Wenn Sie Playwright is not available in this gateway build sehen, fehlt dem paketierten Gateway die zentrale Browser-Laufzeitabhängigkeit. Installieren oder aktualisieren Sie OpenClaw erneut und starten Sie dann den Gateway neu. Installieren Sie für Docker außerdem die Chromium- Browser-Binärdateien wie unten gezeigt.

Docker-Playwright-Installation

Wenn Ihr Gateway in Docker läuft, vermeiden Sie npx playwright (npm-Override-Konflikte). Verwenden Sie stattdessen die gebündelte CLI:

docker compose run --rm openclaw-cli \
  node /app/node_modules/playwright-core/cli.js install chromium

Um Browser-Downloads zu persistieren, setzen Sie PLAYWRIGHT_BROWSERS_PATH (zum Beispiel /home/node/.cache/ms-playwright) und stellen Sie sicher, dass /home/node über OPENCLAW_HOME_VOLUME oder einen Bind-Mount persistiert wird. Siehe Docker.

Funktionsweise (intern)

Ein kleiner Loopback-Control-Server nimmt HTTP-Requests an und verbindet sich per CDP mit Chromium-basierten Browsern. Erweiterte Aktionen (Click/Type/Snapshot/PDF) laufen über Playwright auf CDP; wenn Playwright fehlt, sind nur Nicht-Playwright-Operationen verfügbar. Der Agent sieht eine stabile Schnittstelle, während lokale/Remote-Browser und Profile darunter frei ausgetauscht werden.

CLI-Kurzreferenz

Alle Befehle akzeptieren --browser-profile <name>, um ein bestimmtes Profil anzusteuern, und --json für maschinenlesbare Ausgabe.

Basics: status, tabs, open/focus/close

openclaw browser status
openclaw browser start
openclaw browser start --headless # one-shot local managed headless launch
openclaw browser stop            # also clears emulation on attach-only/remote CDP
openclaw browser tabs
openclaw browser tab             # shortcut for current tab
openclaw browser tab new
openclaw browser tab select 2
openclaw browser tab close 2
openclaw browser open https://example.com
openclaw browser focus abcd1234
openclaw browser close abcd1234

Inspection: screenshot, snapshot, console, errors, requests

openclaw browser screenshot
openclaw browser screenshot --full-page
openclaw browser screenshot --ref 12        # or --ref e12
openclaw browser screenshot --labels
openclaw browser snapshot
openclaw browser snapshot --format aria --limit 200
openclaw browser snapshot --interactive --compact --depth 6
openclaw browser snapshot --efficient
openclaw browser snapshot --labels
openclaw browser snapshot --urls
openclaw browser snapshot --selector "#main" --interactive
openclaw browser snapshot --frame "iframe#main" --interactive
openclaw browser console --level error
openclaw browser errors --clear
openclaw browser requests --filter api --clear
openclaw browser pdf
openclaw browser responsebody "**/api" --max-chars 5000

Actions: navigate, click, type, drag, wait, evaluate

openclaw browser navigate https://example.com
openclaw browser resize 1280 720
openclaw browser click 12 --double           # or e12 for role refs
openclaw browser click-coords 120 340        # viewport coordinates
openclaw browser type 23 "hello" --submit
openclaw browser press Enter
openclaw browser hover 44
openclaw browser scrollintoview e12
openclaw browser drag 10 11
openclaw browser select 9 OptionA OptionB
openclaw browser download e12 report.pdf
openclaw browser waitfordownload report.pdf
openclaw browser upload /tmp/openclaw/uploads/file.pdf
openclaw browser fill --fields '[{"ref":"1","type":"text","value":"Ada"}]'
openclaw browser dialog --accept
openclaw browser wait --text "Done"
openclaw browser wait "#main" --url "**/dash" --load networkidle --fn "window.ready===true"
openclaw browser evaluate --fn '(el) => el.textContent' --ref 7
openclaw browser highlight e12
openclaw browser trace start
openclaw browser trace stop

State: cookies, storage, offline, headers, geo, device

openclaw browser cookies
openclaw browser cookies set session abc123 --url "https://example.com"
openclaw browser cookies clear
openclaw browser storage local get
openclaw browser storage local set theme dark
openclaw browser storage session clear
openclaw browser set offline on
openclaw browser set headers --headers-json '{"X-Debug":"1"}'
openclaw browser set credentials user pass            # --clear to remove
openclaw browser set geo 37.7749 -122.4194 --origin "https://example.com"
openclaw browser set media dark
openclaw browser set timezone America/New_York
openclaw browser set locale en-US
openclaw browser set device "iPhone 14"

Hinweise:

upload und dialog sind vorbereitende Aufrufe; führen Sie sie vor dem Click/Press aus, der die Dateiauswahl/den Dialog auslöst.
click/type/usw. erfordern eine ref aus snapshot (numerisch 12, Rollen-Ref e12 oder ausführbare ARIA-Ref ax12). CSS-Selektoren werden für Aktionen absichtlich nicht unterstützt. Verwenden Sie click-coords, wenn die sichtbare Viewport-Position das einzige zuverlässige Ziel ist.
Download-, Trace- und Upload-Pfade sind auf OpenClaw-Temporärverzeichnisse beschränkt: /tmp/openclaw{,/downloads,/uploads} (Fallback: ${os.tmpdir()}/openclaw/...).
upload kann Dateieingaben auch direkt über --input-ref oder --element setzen.

Stabile Tab-IDs und Labels überstehen den Austausch roher Chromium-Targets, wenn OpenClaw den Ersatztab nachweisen kann, etwa bei derselben URL oder wenn ein einzelner alter Tab nach einer Formularübermittlung zu einem einzelnen neuen Tab wird. Rohe Target-IDs bleiben dennoch flüchtig; bevorzugen Sie suggestedTargetId aus tabs in Skripten.

Snapshot-Flags auf einen Blick:

--format ai (Standard mit Playwright): AI-Snapshot mit numerischen Refs (aria-ref="<n>").
--format aria: Accessibility-Tree mit axN-Refs. Wenn Playwright verfügbar ist, bindet OpenClaw Refs mit Backend-DOM-IDs an die Live-Seite, sodass Folgeaktionen sie verwenden können; andernfalls behandeln Sie die Ausgabe nur als Inspektion.
--efficient (oder --mode efficient): kompaktes Rollen-Snapshot-Preset. Setzen Sie browser.snapshotDefaults.mode: "efficient", um dies zum Standard zu machen (siehe Gateway-Konfiguration).
--interactive, --compact, --depth, --selector erzwingen einen Rollen-Snapshot mit ref=e12-Refs. --frame "<iframe>" beschränkt Rollen-Snapshots auf ein iframe.
--labels fügt einen Viewport-only-Screenshot mit überlagerten Ref-Labels hinzu (gibt MEDIA:<path> aus).
--urls hängt erkannte Link-Ziele an AI-Snapshots an.

Snapshots und Refs

OpenClaw unterstützt zwei „Snapshot“-Stile:

AI-Snapshot (numerische Refs): openclaw browser snapshot (Standard; --format ai)
- Ausgabe: ein Text-Snapshot, der numerische Refs enthält.
- Aktionen: openclaw browser click 12, openclaw browser type 23 "hello".
- Intern wird die Ref über Playwrights aria-ref aufgelöst.
Rollen-Snapshot (Rollen-Refs wie e12): openclaw browser snapshot --interactive (oder --compact, --depth, --selector, --frame)
- Ausgabe: eine rollenbasierte Liste/ein rollenbasierter Baum mit [ref=e12] (und optional [nth=1]).
- Aktionen: openclaw browser click e12, openclaw browser highlight e12.
- Intern wird die Ref über getByRole(...) aufgelöst (plus nth() für Duplikate).
- Fügen Sie --labels hinzu, um einen Viewport-Screenshot mit überlagerten e12-Labels einzuschließen.
- Fügen Sie --urls hinzu, wenn Linktext mehrdeutig ist und der Agent konkrete Navigationsziele benötigt.
ARIA-Snapshot (ARIA-Refs wie ax12): openclaw browser snapshot --format aria
- Ausgabe: der Accessibility-Tree als strukturierte Nodes.
- Aktionen: openclaw browser click ax12 funktioniert, wenn der Snapshot-Pfad die Ref über Playwright und Chrome-Backend-DOM-IDs binden kann.
Wenn Playwright nicht verfügbar ist, können ARIA-Snapshots weiterhin für Inspektion nützlich sein, aber Refs sind möglicherweise nicht ausführbar. Erstellen Sie erneut einen Snapshot mit --format ai oder --interactive, wenn Sie Aktions-Refs benötigen.
Docker-Nachweis für den Raw-CDP-Fallback-Pfad: pnpm test:docker:browser-cdp-snapshot startet Chromium mit CDP, führt browser doctor --deep aus und verifiziert, dass Rollen- Snapshots Link-URLs, Cursor-promoted Clickables und iframe-Metadaten enthalten.

Ref-Verhalten:

Refs sind nicht über Navigationen hinweg stabil; wenn etwas fehlschlägt, führen Sie snapshot erneut aus und verwenden Sie eine frische Ref.
/act gibt nach einer durch eine Aktion ausgelösten Ersetzung die aktuelle rohe targetId zurück, wenn die ersetzte Registerkarte nachgewiesen werden kann. Verwenden Sie für Folgekommandos weiterhin stabile Registerkarten-IDs/-Labels.
Wenn der Rollen-Snapshot mit --frame erstellt wurde, sind Rollen-Refs bis zum nächsten Rollen-Snapshot auf diesen iframe beschränkt.
Unbekannte oder veraltete axN-Refs schlagen sofort fehl, statt auf Playwrights aria-ref-Selektor zurückzufallen. Erstellen Sie in diesem Fall einen frischen Snapshot auf derselben Registerkarte.

Erweiterte Wartefunktionen

Sie können auf mehr als nur Zeit/Text warten:

Auf URL warten (Globs werden von Playwright unterstützt):
- openclaw browser wait --url "**/dash"
Auf Ladezustand warten:
- openclaw browser wait --load networkidle
Auf ein JS-Prädikat warten:
- openclaw browser wait --fn "window.ready===true"
Warten, bis ein Selektor sichtbar wird:
- openclaw browser wait "#main"

Diese Optionen können kombiniert werden:

openclaw browser wait "#main" \
  --url "**/dash" \
  --load networkidle \
  --fn "window.ready===true" \
  --timeout-ms 15000

Debug-Workflows

Wenn eine Aktion fehlschlägt (z. B. „nicht sichtbar“, „Strict-Mode-Verstoß“, „verdeckt“):

openclaw browser snapshot --interactive
Verwenden Sie click <ref> / type <ref> (bevorzugen Sie im interaktiven Modus Rollen-Refs)
Wenn es weiterhin fehlschlägt: openclaw browser highlight <ref>, um zu sehen, worauf Playwright abzielt
Wenn sich die Seite ungewöhnlich verhält:
- openclaw browser errors --clear
- openclaw browser requests --filter api --clear
Für tiefgehendes Debugging: Zeichnen Sie einen Trace auf:
- openclaw browser trace start
- Reproduzieren Sie das Problem
- openclaw browser trace stop (gibt TRACE:<path> aus)

JSON-Ausgabe

--json ist für Skripting und strukturierte Tools gedacht.

Beispiele:

openclaw browser status --json
openclaw browser snapshot --interactive --json
openclaw browser requests --filter api --json
openclaw browser cookies --json

Rollen-Snapshots in JSON enthalten refs sowie einen kleinen stats-Block (Zeilen/Zeichen/Refs/interaktiv), damit Tools Nutzlastgröße und Dichte einschätzen können.

Zustands- und Umgebungsregler

Diese sind nützlich für Workflows nach dem Muster „die Website soll sich wie X verhalten“:

Cookies: cookies, cookies set, cookies clear
Speicher: storage local|session get|set|clear
Offline: set offline on|off
Header: set headers --headers-json '{"X-Debug":"1"}' (das Legacy-Format set headers --json '{"X-Debug":"1"}' wird weiterhin unterstützt)
HTTP-Basic-Auth: set credentials user pass (oder --clear)
Geolocation: set geo <lat> <lon> --origin "https://example.com" (oder --clear)
Medien: set media dark|light|no-preference|none
Zeitzone / Gebietsschema: set timezone ..., set locale ...
Gerät / Viewport:
- set device "iPhone 14" (Playwright-Geräte-Presets)
- set viewport 1280 720

Sicherheit und Datenschutz

Das openclaw-Browserprofil kann angemeldete Sitzungen enthalten; behandeln Sie es als sensibel.
browser act kind=evaluate / openclaw browser evaluate und wait --fn führen beliebiges JavaScript im Seitenkontext aus. Prompt Injection kann dies steuern. Deaktivieren Sie es mit browser.evaluateEnabled=false, wenn Sie es nicht benötigen.
Hinweise zu Anmeldungen und Anti-Bot-Themen (X/Twitter usw.) finden Sie unter Browser-Anmeldung + X/Twitter-Beiträge.
Halten Sie den Gateway-/Node-Host privat (Loopback oder nur Tailnet).
Entfernte CDP-Endpunkte sind leistungsfähig; tunneln und schützen Sie sie.

Strict-Mode-Beispiel (private/interne Ziele standardmäßig blockieren):

{
  browser: {
    ssrfPolicy: {
      dangerouslyAllowPrivateNetwork: false,
      hostnameAllowlist: ["*.example.com", "example.com"],
      allowedHostnames: ["localhost"], // optional exact allow
    },
  },
}

Browsersteuerungs-API

Control-API (optional)

`/act`-Fehlervertrag

Playwright-Anforderung

Docker-Playwright-Installation

Funktionsweise (intern)

CLI-Kurzreferenz

Snapshots und Refs

Erweiterte Wartefunktionen

Debug-Workflows

JSON-Ausgabe

Zustands- und Umgebungsregler

Sicherheit und Datenschutz

Verwandte Themen

Ask OpenClaw

# Control-API (optional)

# /act-Fehlervertrag

# Playwright-Anforderung

# Docker-Playwright-Installation

# Funktionsweise (intern)

# CLI-Kurzreferenz

# Snapshots und Refs

# Erweiterte Wartefunktionen

# Debug-Workflows

# JSON-Ausgabe

# Zustands- und Umgebungsregler

# Sicherheit und Datenschutz

# Verwandte Themen

Control-API (optional)

`/act`-Fehlervertrag

Playwright-Anforderung

Docker-Playwright-Installation

Funktionsweise (intern)

CLI-Kurzreferenz

Snapshots und Refs

Erweiterte Wartefunktionen

Debug-Workflows

JSON-Ausgabe

Zustands- und Umgebungsregler

Sicherheit und Datenschutz

Verwandte Themen