Skip to content

Java API Reference

All 187 entries of the Java client API, grouped by object. Each entry shows the signature from the client’s own source, then the matching CLI command and MCP tool where one exists.

Entries marked (nightly) are not in the latest release (26.11.16); (changed in nightly) means the documented signature differs from that release. Signatures come from the latest nightly build. See What’s in Nightly. The same data for every surface is in the API matrix and in /api.json.

Examples assume bro is a started browser and vibe is its page, as in the quickstart.

Vibium.start(options?)

Launch browser and connect

  • public static Browser start();
  • public static Browser start(StartOptions options);

Start a visible browser.

Example: Browser bro = Vibium.start(new StartOptions().headless(true));

CLI vibium start · MCP browser_start

browser.page()

Get the default page

public Page page();

Example: Page vibe = bro.page();

browser.newPage()

Create a new page

public Page newPage();

Create a new page (tab).

Example: Page second = bro.newPage();

CLI vibium page new · MCP browser_new_page

browser.newContext()

Create a new browser context

public BrowserContext newContext();

Create a new browser context (isolated cookies/storage).

browser.pages()

List all pages

public List<Page> pages();

List all open pages.

CLI vibium pages · MCP browser_list_pages

browser.stop()

Stop the browser

public void stop();

Stop the browser and clean up.

Example: bro.stop();

CLI vibium stop · MCP browser_stop

browser.onPage(cb)

Listen for new page events

public void onPage(Consumer<Page> callback);

browser.onPopup(cb)

Listen for popup events

public void onPopup(Consumer<Page> callback);

browser.removeAllListeners(ev?)

Remove all event listeners

  • public void removeAllListeners(String event);
  • public void removeAllListeners();

Remove all event listeners, optionally filtered by event name.

browser.context()

Get the default context

public BrowserContext context();

Get the default browser context.

page.go(url)

Navigate to a URL

public void go(String url);

Example: vibe.go("https://example.com");

CLI vibium go <url> · MCP browser_navigate

page.back()

Go back

public void back();

Go back in history.

Example: vibe.back();

CLI vibium back · MCP browser_back

page.forward()

Go forward

public void forward();

Go forward in history.

CLI vibium forward · MCP browser_forward

page.reload()

Reload page

public void reload();

Reload the page.

Example: vibe.reload();

CLI vibium reload · MCP browser_reload

page.url()

Get current URL

public String url();

Get the current URL.

Example: String url = vibe.url();

CLI vibium url · MCP browser_get_url

page.title()

Get page title

public String title();

Get the page title.

Example: String title = vibe.title();

CLI vibium title · MCP browser_get_title

page.content()

Get page HTML

public String content();

Get the full page HTML.

Example: String html = vibe.content();

page.find(locator, options?)

Find a single element by description (a bare string), css, tag, semantic locator, or reference image; strategy auto, cv, vlm, or tree

  • public Element find(String description);
  • public Element find(String description, FindOptions options);
  • public Element find(SelectorOptions options);

Find a single element by natural-language description, e.g. “the Add to Cart button”. For an exact locator use find(SelectorOptions) with css, tag, role, text, or image.

Example: Element button = vibe.find(new SelectorOptions().role("button").text("Submit"));

CLI vibium find <description> · MCP browser_find

page.findAll(locator, options?)

Find all matching elements, same locator forms

  • public List<Element> findAll(String description);
  • public List<Element> findAll(String description, FindOptions options);
  • public List<Element> findAll(SelectorOptions options);

Find all matching elements by CSS selector. Waits up to the timeout for at least one match, then returns an empty list if there is none. Each element carries a snapshot of its tag, text, and bounding box taken at findAll time, readable via Element#info() with no further round trips: els.stream().map(e -> e.info().text()). Live reads like Element#text() re-resolve the element and fail if the page has changed since findAll.

Example: List<Element> links = vibe.findAll(new SelectorOptions().role("link"));

CLI vibium find --all <description> · MCP browser_find_all

page.screenshot(options?)

Take a page screenshot

  • public byte[] screenshot();
  • public byte[] screenshot(ScreenshotOptions options);

Take a screenshot, returns PNG bytes.

Example: Files.write(Path.of("page.png"), vibe.screenshot());

CLI vibium screenshot · MCP browser_screenshot

page.pdf(options?)

Generate PDF

  • public byte[] pdf();
  • public byte[] pdf(PdfOptions options);

Generate a PDF, returns PDF bytes (headless only).

CLI vibium pdf · MCP browser_pdf

page.evaluate(expr)

Evaluate JavaScript

public Object evaluate(String expression);

Evaluate a JavaScript expression.

Example: Object count = vibe.evaluate("document.links.length");

CLI vibium eval <expr> · MCP browser_evaluate

page.addScript(src)

Add a script tag

public void addScript(String source);

Add a script tag to the page. Pass a URL or inline JavaScript.

page.addStyle(src)

Add a style tag

public void addStyle(String source);

Add a style tag to the page. Pass a URL or inline CSS.

page.expose(name, fn)

Expose a function to the page

  • public void expose(String name, String fn);
  • public void expose(String name, Function<Object[], Object> callback);

Define window[name] in the page from JS function source, in the current document and every later one, matching the JS and Python clients: page.expose(“double”, “(n) => n * 2”).

page.sleep(ms)

Wait for a duration

public void sleep(long ms);

Wait for a fixed duration in milliseconds.

CLI vibium sleep <ms> · MCP browser_sleep

page.waitFor(sel, options?)

Wait for a selector

  • public Element waitFor(String selector);
  • public Element waitFor(String selector, FindOptions options);

Wait for an element matching the selector.

CLI vibium wait <sel> · MCP browser_wait

page.waitForFunction(fn, options?)

Wait for JS function to return truthy

  • public Object waitForFunction(String fn);
  • public Object waitForFunction(String fn, WaitOptions options);

Wait for a JS function to return truthy.

Example: vibe.waitForFunction("document.readyState === \"complete\"");

CLI vibium wait fn <expr> · MCP browser_wait_for_fn

page.waitForURL(url, options?)

Wait for URL to match

  • public void waitForURL(String pattern);
  • public void waitForURL(String pattern, WaitOptions options);

Wait for URL to match a pattern.

Example: vibe.waitForURL("**/next");

CLI vibium wait url <pat> · MCP browser_wait_for_url

page.waitForLoad(options?)

Wait for page load

  • public void waitForLoad();
  • public void waitForLoad(WaitOptions options);

Example: vibe.waitForLoad();

CLI vibium wait load · MCP browser_wait_for_load

page.scroll(options?)

Scroll the page

  • public void scroll();
  • public void scroll(ScrollOptions options);

Scroll the page (default: down).

CLI vibium scroll <dir> <amt> · MCP browser_scroll

page.setViewport(size)

Set viewport size

public void setViewport(ViewportSize size);

Set the viewport size.

Example: vibe.setViewport(new ViewportSize(375, 812));

CLI vibium viewport <w> <h> · MCP browser_set_viewport

page.viewport()

Get viewport size

public ViewportSize viewport();

Get the viewport size.

CLI vibium viewport · MCP browser_get_viewport

page.emulateMedia(opts)

Override CSS media features

public void emulateMedia(MediaOptions options);

CLI vibium media <scheme> · MCP browser_emulate_media

page.setContent(html)

Set page HTML

public void setContent(String html);

Set page HTML content.

Example: vibe.setContent("<h1>Hello</h1>");

CLI vibium content <html> · MCP browser_set_content

page.setGeolocation(coords)

Override geolocation

public void setGeolocation(GeoCoords coords);

CLI vibium geolocation <lat> <lon> · MCP browser_set_geolocation

page.setWindow(opts)

Set window size/position

public void setWindow(WindowOptions options);

CLI vibium window <opts> · MCP browser_set_window

page.window()

Get window info

public WindowInfo window();

CLI vibium window · MCP browser_get_window

page.a11yTree(options?)

Get accessibility tree

  • public A11yNode a11yTree();
  • public A11yNode a11yTree(A11yOptions options);

Get the accessibility tree.

Example: A11yNode tree = vibe.a11yTree();

CLI vibium a11y-tree · MCP browser_a11y_tree

page.frames()

List all frames

public List<Page> frames();

CLI vibium frames · MCP browser_frames

page.frame(nameOrUrl)

Get a frame by name/URL

public Page frame(String nameOrUrl);

Get a frame by name or URL.

CLI vibium frame <ref> · MCP browser_frame

page.mainFrame()

Get the main frame

public Page mainFrame();

Get the main frame (self for top-level pages).

page.bringToFront()

Bring page to front

public void bringToFront();

Bring this page/tab to the front.

CLI vibium page switch <idx> · MCP browser_switch_page

page.close()

Close the page

public void close();

Close this page/tab.

CLI vibium page close · MCP browser_close_page

page.route(pattern, handler)

Register a route handler

public void route(String pattern, Consumer<Route> handler);

Register a route handler for a URL pattern. The binary compiles the pattern, owns the intercept lifecycle, and annotates blocked request events with the patterns that matched, so dispatch never interprets the glob client-side.

page.unroute(pattern)

Remove a route handler

public void unroute(String pattern);

page.setHeaders(headers)

Set extra HTTP headers

public void setHeaders(Map<String, String> headers);

Set extra HTTP headers for this page.

page.onRequest(fn)

Listen for requests

public void onRequest(Consumer<Request> callback);

Listen for network requests.

Example: vibe.onRequest(req -> System.out.println(req.method() + " " + req.url()));

page.onResponse(fn)

Listen for responses

public void onResponse(Consumer<Response> callback);

Listen for network responses.

Example: vibe.onResponse(resp -> System.out.println(resp.status() + " " + resp.url()));

page.onDialog(fn)

Listen for dialogs

public void onDialog(Consumer<Dialog> callback);

page.onConsole(fn)

Listen for console messages

public void onConsole(Consumer<ConsoleMessage> callback);

Example: vibe.onConsole(msg -> System.out.println(msg.type() + " " + msg.text()));

page.onError(fn)

Listen for page errors

public void onError(Consumer<String> callback);

page.onDownload(fn)

Listen for downloads

public void onDownload(Consumer<Download> callback);

page.onWebSocket(fn)

Subscribe to WebSocket events

public void onWebSocket(Consumer<WebSocketInfo> callback);

Listen for WebSocket connections.

page.removeAllListeners(ev?)

Remove all event listeners

  • public void removeAllListeners(String event);
  • public void removeAllListeners();

Remove all event listeners, optionally by event name.

page.capture().response(pat, action)

Capture response (before action)

  • public Response response(String pattern, Runnable action);
  • public Response response(String pattern, Runnable action, WaitOptions options);

Example: Response resp = vibe.capture().response("**/api/users", () -> vibe.find(new SelectorOptions().role("button").text("Users")).click());

page.capture().request(pat, action)

Capture request (before action)

  • public Request request(String pattern, Runnable action);
  • public Request request(String pattern, Runnable action, WaitOptions options);

page.capture().navigation(action)

Capture navigation (before action)

  • public String navigation(Runnable action);
  • public String navigation(Runnable action, WaitOptions options);

page.capture().event(name, action)

Capture event (before action)

  • public Object event(String name, Runnable action);
  • public Object event(String name, Runnable action, WaitOptions options);

page.capture().download(action)

Capture download (before action)

  • public Download download(Runnable action);
  • public Download download(Runnable action, WaitOptions options);

Example: Download download = vibe.capture().download(() -> vibe.find(new SelectorOptions().role("link").text("Download")).click());

page.capture().dialog(action)

Capture dialog (before action)

  • public Dialog dialog(Runnable action);
  • public Dialog dialog(Runnable action, WaitOptions options);

page.consoleMessages()

Get buffered console messages

public List<ConsoleMessage> consoleMessages();

page.errors()

Get buffered page errors

public List<String> errors();

page.context()

Owning browser context

public BrowserContext context();

Get the parent BrowserContext.

page.id()

Browsing context id

public String id();

Get the browsing context ID.

page.capture()

One-shot capture namespace

public Capture capture();

Get the one-shot event capture helpers for this page.

page.keyboard()

Keyboard input for the page

public Keyboard keyboard();

Get the Keyboard for this page.

page.mouse()

Mouse input for the page

public Mouse mouse();

Get the Mouse for this page.

page.touch()

Touch input for the page

public Touch touch();

Get the Touch for this page.

page.clock()

Clock control for the page

public Clock clock();

Get the Clock for this page.

page.collectConsole()

Enable console collect mode

public void collectConsole();

Collect console messages into a buffer (retrieve with consoleMessages()).

page.collectErrors()

Enable error collect mode

public void collectErrors();

Collect errors into a buffer (retrieve with errors()).

el.click()

Click an element

public void click();

Click the element.

Example: vibe.find(new SelectorOptions().role("button").text("Submit")).click();

CLI vibium click <sel> · MCP browser_click

el.dblclick()

Double-click an element

public void dblclick();

Double-click the element.

CLI vibium dblclick <sel> · MCP browser_dblclick

el.fill(value)

Fill an input field

public void fill(String value);

Fill an input field (clears existing content first).

Example: vibe.find(new SelectorOptions().label("Email")).fill("user@example.com");

CLI vibium fill <sel> <val> · MCP browser_fill

el.type(text)

Type text character by character

public void type(String text);

Type text character by character (appends).

Example: vibe.find(new SelectorOptions().label("Email")).type("user@example.com");

CLI vibium type <text> · MCP browser_type

el.press(key)

Press a key on focused element

public void press(String key);

Press a key or key combination.

Example: vibe.find(new SelectorOptions().label("Email")).press("Enter");

CLI vibium press <key> · MCP browser_press

el.clear()

Clear an input field

public void clear();

Clear the input field.

el.set(value?)

Check a checkbox

  • public void set();
  • public void set(boolean value);

Example: vibe.find(new SelectorOptions().css("input[type=\"checkbox\"]")).set();

CLI vibium set <sel> · MCP browser_set

el.unset()

Uncheck a checkbox

public void unset();

CLI vibium unset <sel> · MCP browser_unset

el.selectOption(val)

Select a dropdown option

public void selectOption(String value);

Select a dropdown option by value.

Example: vibe.find(new SelectorOptions().label("Country")).selectOption("de");

CLI vibium select <sel> <val> · MCP browser_select

el.hover()

Hover over an element

public void hover();

Hover over the element.

Example: vibe.find(new SelectorOptions().role("button").text("Menu")).hover();

CLI vibium hover <sel> · MCP browser_hover

el.focus()

Focus an element

public void focus();

Focus the element.

CLI vibium focus <sel> · MCP browser_focus

el.dragTo(target)

Drag an element to a target

public void dragTo(Element target);

Drag this element to a target element.

CLI vibium drag <sel> <x> <y> · MCP browser_drag

el.tap()

Tap an element (touch)

public void tap();

Tap the element (touch).

el.scrollIntoView()

Scroll element into view

public void scrollIntoView();

Scroll the element into view.

CLI vibium scroll into-view <sel> · MCP browser_scroll_into_view

el.dispatchEvent(type, init?)

Dispatch a DOM event

  • public void dispatchEvent(String eventType);
  • public void dispatchEvent(String eventType, Map<String, Object> eventInit);

el.setFiles(files)

Set files on a file input

public void setFiles(List<String> files);

CLI vibium upload <sel> <paths> · MCP browser_upload

el.highlight()

Highlight an element

public void highlight();

Highlight the element visually.

CLI vibium highlight <sel> · MCP browser_highlight

el.text()

Get element text content

public String text();

Get the text content (trimmed).

Example: String heading = vibe.find(new SelectorOptions().css("h1")).text();

CLI vibium text <sel> · MCP browser_get_text

el.innerText()

Get element inner text

public String innerText();

Get the inner text (rendered).

CLI vibium text <sel> · MCP browser_get_text

el.html()

Get element outer HTML

public String html();

Get the outer HTML.

CLI vibium html <sel> · MCP browser_get_html

el.value()

Get input element value

public String value();

Get the input value.

Example: String email = vibe.find(new SelectorOptions().label("Email")).value();

CLI vibium value <sel> · MCP browser_get_value

el.attr(name)

Get element attribute

public String attr(String name);

Get an attribute value.

Example: String href = vibe.find(new SelectorOptions().role("link").text("Next")).attr("href");

CLI vibium attr <sel> <name> · MCP browser_get_attribute

el.bounds()

Get element bounding box

public BoundingBox bounds();

Get the bounding box.

el.boundingBox()

Bounding box (Playwright-compat alias for bounds)

public BoundingBox boundingBox();

Alias for bounds(). Playwright compat.

el.getAttribute(name)

Get attribute (alias for attr)

public String getAttribute(String name);

Alias for attr(). Playwright compat.

el.info()

Find-time snapshot of tag, text, and box

public ElementInfo info();

Get info about this element (tag, text, bounding box).

el.isVisible()

Check if element is visible

public boolean isVisible();

Check if the element is visible.

Example: boolean visible = vibe.find(new SelectorOptions().role("button").text("Submit")).isVisible();

CLI vibium is visible <sel> · MCP browser_is_visible

el.isHidden()

Check if element is hidden

public boolean isHidden();

Check if the element is hidden.

el.isEnabled()

Check if element is enabled

public boolean isEnabled();

Check if the element is enabled.

CLI vibium is enabled <sel> · MCP browser_is_enabled

el.isSet()

Check if element is checked

public boolean isSet();

Check if the element is checked.

CLI vibium is set <sel> · MCP browser_is_set

el.isEditable()

Check if element is editable

public boolean isEditable();

Check if the element is editable.

el.role()

Get element ARIA role

public String role();

Get the ARIA role.

el.label()

Get element accessible label

public String label();

Get the accessible label.

el.screenshot()

Screenshot an element

public byte[] screenshot();

Take a screenshot of the element, returns PNG bytes.

el.waitUntil(state?, options?)

Wait for element state

  • public void waitUntil();
  • public void waitUntil(String state);
  • public void waitUntil(String state, FindOptions options);

Wait for the element to reach a state. Default: “visible”.

CLI vibium wait <sel> --state <st> · MCP browser_wait

el.find(sel, options?)

Find a child element (scoped)

  • public Element find(String description);
  • public Element find(String description, FindOptions options);
  • public Element find(SelectorOptions childOptions);

Find a child element by natural-language description, scoped to this element.

Example: Element home = vibe.find(new SelectorOptions().css("nav")).find(new SelectorOptions().role("link").text("Home"));

el.findAll(sel, options?)

Find all child elements (scoped)

  • public List<Element> findAll(String description);
  • public List<Element> findAll(String description, FindOptions options);
  • public List<Element> findAll(SelectorOptions childOptions);

Find all child elements by description, scoped to this element.

context.newPage()

Create a page in a context

public Page newPage();

Create a new page in this context.

context.close()

Close the context

public void close();

Close this context.

context.cookies(urls?)

Get cookies

public List<Cookie> cookies(String... urls);

Get cookies, optionally filtered by URLs.

CLI vibium cookies · MCP browser_get_cookies

context.setCookies(cookies)

Set cookies

public void setCookies(List<SetCookieParam> cookies);

CLI vibium cookies <n> <v> · MCP browser_set_cookie

context.clearCookies()

Clear cookies

public void clearCookies();

Clear all cookies.

CLI vibium cookies clear · MCP browser_delete_cookies

context.storage()

Get storage state

public StorageState storage();

CLI vibium storage · MCP browser_storage_state

context.setStorage(state)

Set storage state

public void setStorage(StorageState state);

MCP browser_restore_storage

context.clearStorage()

Clear all storage

public void clearStorage();

context.addInitScript(script)

Add an init script

public String addInitScript(String script);

context.id()

User context id

public String id();

Get the context ID.

context.recording()

Recording controls for the context

public Recording recording();

Get the Recording for this context.

keyboard.press(key)

Press a key

public void press(String key);

Press a key (down + up).

Example: vibe.keyboard().press("Enter");

CLI vibium keys <keys> · MCP browser_keys

keyboard.down(key)

Key down

public void down(String key);

Hold a key down.

keyboard.up(key)

Key up

public void up(String key);

Release a key.

keyboard.type(text)

Type text

public void type(String text);

Type text character by character.

mouse.click(x, y, options?)

Click at coordinates

  • public void click(double x, double y);
  • public void click(double x, double y, MouseOptions options);

CLI vibium mouse click <x> <y> · MCP browser_mouse_click

mouse.move(x, y, options?)

Move mouse

  • public void move(double x, double y);
  • public void move(double x, double y, MouseOptions options);

Move mouse to coordinates.

CLI vibium mouse move <x> <y> · MCP browser_mouse_move

mouse.down(options?)

Mouse button down

  • public void down();
  • public void down(MouseOptions options);

Press mouse button down.

CLI vibium mouse down · MCP browser_mouse_down

mouse.up(options?)

Mouse button up

  • public void up();
  • public void up(MouseOptions options);

Release mouse button.

CLI vibium mouse up · MCP browser_mouse_up

mouse.wheel(dx, dy)

Scroll mouse wheel

public void wheel(double deltaX, double deltaY);

Scroll the mouse wheel at the current pointer position.

touch.tap(x, y)

Tap at coordinates

public void tap(double x, double y);

CLI vibium tap <x> <y> · MCP browser_tap

clock.install(options?)

Install fake timers

  • public void install();
  • public void install(ClockOptions options);

MCP page_clock_install

clock.fastForward(ticks)

Fast-forward time

public void fastForward(long ticks);

Fast-forward time by milliseconds.

MCP page_clock_fast_forward

clock.runFor(ticks)

Run timers for a duration

public void runFor(long ticks);

Run timers for a duration in milliseconds.

MCP page_clock_run_for

clock.pauseAt(time)

Pause clock at a time

public void pauseAt(String time);

Pause the clock at a specific time.

MCP page_clock_pause_at

clock.resume()

Resume clock

public void resume();

Resume the clock.

MCP page_clock_resume

clock.setFixedTime(time)

Set fixed fake time

public void setFixedTime(String time);

MCP page_clock_set_fixed_time

clock.setSystemTime(time)

Set system time

public void setSystemTime(String time);

MCP page_clock_set_system_time

clock.setTimezone(tz)

Set timezone

public void setTimezone(String timezone);

MCP page_clock_set_timezone

recording.start(options?)

Start recording

  • public void start();
  • public void start(RecordingOptions options);

CLI vibium record start · MCP browser_record_start

recording.stop(path?)

Stop recording, return trace

  • public RecordingResult stop();
  • public RecordingResult stop(String path);

Stop recording and deliver the zip to the declared path.

CLI vibium record stop · MCP browser_record_stop

recording.startChunk(options?)

Start a recording chunk

  • public void startChunk();
  • public void startChunk(ChunkOptions options);

CLI vibium record chunk start · MCP browser_record_start_chunk

recording.stopChunk(path?)

Stop a recording chunk

  • public RecordingResult stopChunk();
  • public RecordingResult stopChunk(String path);

Stop a recording chunk; without a path its bytes come back inline.

CLI vibium record chunk stop · MCP browser_record_stop_chunk

recording.startGroup(name, location?)

Start a logical group

  • public void startGroup(String name);
  • public void startGroup(String name, String location);

CLI vibium record group start <name> · MCP browser_record_start_group

recording.stopGroup()

Stop a logical group

public void stopGroup();

Stop the current logical group.

CLI vibium record group stop · MCP browser_record_stop_group

route.request()

Access intercepted request

public Request request();

Get the intercepted request.

route.fulfill(options?)

Fulfill an intercepted request

  • public void fulfill();
  • public void fulfill(FulfillOptions options);

Fulfill the request with a custom response.

route.doContinue(options?)

Continue an intercepted request

  • public void doContinue();
  • public void doContinue(ContinueOptions options);

Continue the request (optionally with overrides). Named doContinue() because “continue” is a Java reserved word.

route.abort()

Abort an intercepted request

public void abort();

Abort the request.

dialog.message()

Get dialog message

public String message();

Get the dialog message text.

dialog.type()

Get dialog type

public String type();

Get the dialog type (alert, confirm, prompt, beforeunload).

dialog.defaultValue()

Get dialog default value

public String defaultValue();

Get the default value (for prompt dialogs).

dialog.accept(promptText?)

Accept the dialog

  • public void accept();
  • public void accept(String promptText);

CLI vibium dialog accept · MCP browser_dialog_accept

dialog.dismiss()

Dismiss the dialog

public void dismiss();

CLI vibium dialog dismiss · MCP browser_dialog_dismiss

download.saveAs(path)

Save a download to path

public void saveAs(String path);

Save the download to a path.

download.url()

Get download URL

public String url();

Get the download URL.

download.suggestedFilename()

Get download filename

public String suggestedFilename();

Get the suggested filename.

download.path()

Get download path

public String path();

Get the temp file path (waits for download to complete). Completion is awaited in the engine (vibium:download.await), which tracks every download by its navigation id, so this client keeps no pending-downloads map. Finished downloads answer immediately, so asking repeatedly is fine.

request.url()

Get request URL

public String url();

Get the request URL.

request.method()

Get HTTP method

public String method();

Get the HTTP method.

request.headers()

Get request headers

public Map<String, String> headers();

Get the request headers.

request.requestId()

Get BiDi request ID

public String requestId();

Get the request ID.

request.postData()

Get request body

public String postData();

Get the request body, or null when it is unavailable. The lookup is bounded so it cannot hold up a route handler.

response.url()

Get response URL

public String url();

Get the response URL.

response.status()

Get HTTP status

public int status();

Get the HTTP status code.

response.headers()

Get response headers

public Map<String, String> headers();

Get the response headers.

response.requestId()

Get associated request ID

public String requestId();

Get the request ID.

response.body()

Get response body

public String body();

Get the response body as a string.

response.json()

Parse response body as JSON

public Object json();

Parse the response body as JSON.

message.type()

Get console message type

public String type();

Get the message type (log, warn, error, debug, info).

message.text()

Get formatted message text

public String text();

Get the message text.

message.args()

Get console arguments

public List<Object> args();

Get the message arguments.

message.location()

Get source location

public SourceLocation location();

Get the source location.

socket.url()

Get WebSocket URL

public String url();

Get the WebSocket URL.

socket.onMessage(fn)

Listen for messages

public void onMessage(BiConsumer<String, String> callback);

Listen for messages. The callback receives (data, direction) where direction is “sent” or “received”.

socket.onClose(fn)

Listen for close

public void onClose(BiConsumer<Integer, String> callback);

Listen for close events. The callback receives (code, reason).

socket.isClosed()

Check whether socket is closed

public boolean isClosed();

Check if the WebSocket is closed.

browser.check(claim, options?)

Independently verify the active session or a saved archive

  • public CheckResult check(String claim);
  • public CheckResult check(String claim, CheckOptions options);

Verify the existing session with a fresh verifier inference context.

CLI vibium check <claim> · MCP vibium_check

page.check(claim, options?)

Independently verify a pinned page or a saved archive

  • public CheckResult check(String claim);
  • public CheckResult check(String claim, CheckOptions options);

Verify the existing session with a fresh verifier inference context.

Vibium.check(claim, options)

Check a saved archive without launching a browser

public static com.vibium.types.CheckResult check(String claim, com.vibium.types.CheckOptions options);

Inspect a saved recording without installing or starting a browser.

browser.run(goal, opts?)

Accomplish a goal in the active browser session

  • public RunResult run(String goal);
  • public RunResult run(String goal, RunOptions options);

Accomplish a goal through the existing runtime in this live session.

CLI vibium run <goal> · MCP vibium_run

page.run(goal, opts?)

Accomplish a goal on a pinned page

  • public RunResult run(String goal);
  • public RunResult run(String goal, RunOptions options);

Accomplish a goal through the existing runtime in this live session.

browser.say(text, options?)

Speak text into the session, this machine’s speakers, or a WAV file

  • public SayResult say(String text);
  • public SayResult say(String text, SayOptions options);

Speak text into the current page’s microphone, or into the device.

CLI vibium say <text> · MCP vibium_say

page.say(text, options?)

Speak text into a pinned page

  • public SayResult say(String text);
  • public SayResult say(String text, SayOptions options);

Speak text into this page’s microphone, or into the device.

browser.listen(options?)

Hear the session, this machine’s microphone, or a WAV file, and return a transcript

  • public ListenResult listen();
  • public ListenResult listen(ListenOptions options);

Hear what the current page, or the device, plays, and return its words.

CLI vibium listen · MCP vibium_listen

page.listen(options?)

Hear a pinned page and return a transcript

  • public ListenResult listen();
  • public ListenResult listen(ListenOptions options);

Hear what this page, or the device, plays, and return its words.

Vibium.say(text, options?)

Speak with no browser, into this machine’s speakers or a WAV file

  • public static com.vibium.types.SayResult say(String text);
  • public static com.vibium.types.SayResult say(String text, com.vibium.types.SayOptions options);

Vibium.listen(options?)

Listen with no browser, to this machine’s microphone or a WAV file

  • public static com.vibium.types.ListenResult listen();
  • public static com.vibium.types.ListenResult listen(com.vibium.types.ListenOptions options);

Option and result types named in the signatures above.

class A11yNode {
public String role();
public String name();
public String value();
public String description();
public Boolean disabled();
public Boolean expanded();
public Boolean focused();
public String checked();
public Boolean pressed();
public Boolean selected();
public Integer level();
public Boolean multiselectable();
public List<A11yNode> children();
}
class A11yOptions {
public A11yOptions everything(boolean everything);
public A11yOptions root(String root);
}
class BoundingBox {
public BoundingBox(double x, double y, double width, double height);
public double x();
public double y();
public double width();
public double height();
}
class CheckOptions {
public CheckOptions record(Path path);
public Path record();
public CheckOptions baseURL(String value);
public String baseURL();
public static CheckOptions builder();
public CheckOptions build();
}
class CheckResult {
public String status();
public String claim();
public String summary();
public List<Evidence> evidence();
}
class ChunkOptions {
public ChunkOptions name(String name);
public ChunkOptions title(String title);
}
class ClockOptions {
public ClockOptions time(String time);
public ClockOptions timezone(String timezone);
}
class ContinueOptions {
public ContinueOptions url(String url);
public ContinueOptions method(String method);
public ContinueOptions headers(Map<String, String> headers);
public ContinueOptions postData(String postData);
}
class Cookie {
public String name();
public String value();
public String domain();
public String path();
public int size();
public boolean httpOnly();
public boolean secure();
public String sameSite();
public Long expiry();
}
class ElementInfo {
public ElementInfo(String tag, String text, BoundingBox box);
public ElementInfo(String tag, String text, BoundingBox box, String ref, String role, String name, String source, String selector);
public String tag();
public String text();
public BoundingBox box();
public String ref();
public String role();
public String name();
public String source();
public String selector();
}
class FindOptions {
public FindOptions timeout(long timeout);
public Long timeout();
}
class FulfillOptions {
public FulfillOptions status(int status);
public FulfillOptions headers(Map<String, String> headers);
public FulfillOptions contentType(String contentType);
public FulfillOptions body(String body);
}
class GeoCoords {
public GeoCoords(double latitude, double longitude);
public GeoCoords accuracy(double accuracy);
public Double accuracy();
public double latitude();
public double longitude();
}
class ListenOptions {
public ListenOptions silence(int ms);
public Integer silence();
public ListenOptions timeout(int ms);
public Integer timeout();
public ListenOptions duration(int ms);
public Integer duration();
public ListenOptions allowSilence(boolean value);
public Boolean allowSilence();
public ListenOptions path(String value);
public String path();
public ListenOptions transcribe(boolean value);
public Boolean transcribe();
public static ListenOptions builder();
public ListenOptions build();
}
class ListenResult {
public String text();
public boolean transcribed();
public boolean speech();
public List<Segment> segments();
public List<Word> words();
public Double onsetMs();
public Double speechEndMs();
public Double latencyMs();
public String stoppedBy();
public double durationMs();
public String target();
public String provider();
public String model();
public String path();
public double lostMs();
}
class MediaOptions {
public MediaOptions media(String media);
public MediaOptions colorScheme(String colorScheme);
public MediaOptions reducedMotion(String reducedMotion);
public MediaOptions forcedColors(String forcedColors);
public MediaOptions contrast(String contrast);
}
class MouseOptions {
public MouseOptions button(String button);
public MouseOptions clickCount(int clickCount);
}
class OriginState {
public String origin();
public List<StorageEntry> localStorage();
public List<StorageEntry> sessionStorage();
}
class PdfOptions {
public PdfOptions landscape(boolean landscape);
public Boolean landscape();
public PdfOptions scale(double scale);
public Double scale();
public PdfOptions background(boolean background);
public Boolean background();
public PdfOptions marginTop(double cm);
public Double marginTop();
public PdfOptions marginBottom(double cm);
public Double marginBottom();
public PdfOptions marginLeft(double cm);
public Double marginLeft();
public PdfOptions marginRight(double cm);
public Double marginRight();
public PdfOptions margin(double cm);
public PdfOptions pageWidth(double cm);
public Double pageWidth();
public PdfOptions pageHeight(double cm);
public Double pageHeight();
public PdfOptions pageRanges(List<Object> pageRanges);
public List<Object> pageRanges();
public PdfOptions shrinkToFit(boolean shrinkToFit);
public Boolean shrinkToFit();
}
class RecordingOptions {
public RecordingOptions name(String name);
public RecordingOptions screenshots(boolean screenshots);
public RecordingOptions snapshots(boolean snapshots);
public RecordingOptions sources(boolean sources);
public RecordingOptions title(String title);
public RecordingOptions bidi(boolean bidi);
public RecordingOptions format(String format);
public RecordingOptions quality(double quality);
public RecordingOptions video(boolean video);
public RecordingOptions videoSize(int width, int height);
public RecordingOptions videoWidth(int width);
public RecordingOptions videoHeight(int height);
public RecordingOptions videoFrameRate(int frameRate);
public RecordingOptions videoRemote(String mode);
public RecordingOptions path(String path);
}
class RecordingResult {
public RecordingResult(String path, byte[] bytes, Integer steps, Long durationMs, List<Map<String, Object>> videos, String videoUnavailable);
public String path();
public byte[] bytes();
public Integer steps();
public Long durationMs();
public List<Map<String, Object>> videos();
public String videoUnavailable();
}
class RunOptions {
public RunOptions baseURL(String value);
public String baseURL();
public static RunOptions builder();
public RunOptions build();
}
class RunResult {
public String status();
public String goal();
public String summary();
public List<Evidence> evidence();
}
class SayOptions {
public SayOptions file(String path);
public String file();
public SayOptions voice(String value);
public String voice();
public SayOptions speed(double value);
public Double speed();
public SayOptions cache(boolean value);
public Boolean cache();
public SayOptions cacheDir(String path);
public String cacheDir();
public static SayOptions builder();
public SayOptions build();
}
class SayResult {
public String text();
public String target();
public String provider();
public String model();
public String voice();
public double durationMs();
public boolean cached();
public String sha256();
public String path();
public String file();
}
class ScreenshotOptions {
public ScreenshotOptions fullPage(boolean fullPage);
public Boolean fullPage();
public ScreenshotOptions clip(double x, double y, double width, double height);
public ClipRegion clip();
}
class ScrollOptions {
public ScrollOptions direction(String direction);
public String direction();
public ScrollOptions amount(int amount);
public Integer amount();
public ScrollOptions selector(String selector);
public String selector();
}
class SelectorOptions {
public SelectorOptions description(String description);
public SelectorOptions image(byte[] png);
public SelectorOptions image(Path file);
public SelectorOptions css(String css);
public String css();
public SelectorOptions tag(String tag);
public SelectorOptions name(String name);
public SelectorOptions role(String role);
public SelectorOptions text(String text);
public SelectorOptions label(String label);
public SelectorOptions placeholder(String placeholder);
public SelectorOptions alt(String alt);
public SelectorOptions title(String title);
public SelectorOptions testid(String testid);
public SelectorOptions xpath(String xpath);
public SelectorOptions near(String near);
public SelectorOptions strategy(String strategy);
public SelectorOptions details(boolean details);
public SelectorOptions provider(String provider);
public SelectorOptions model(String model);
public SelectorOptions aiBaseURL(String aiBaseURL);
public SelectorOptions reasoningEffort(String reasoningEffort);
public SelectorOptions timeout(long timeout);
public boolean resolvedHandle();
}
class SetCookieParam {
public SetCookieParam(String name, String value);
public SetCookieParam domain(String domain);
public SetCookieParam url(String url);
public SetCookieParam path(String path);
public SetCookieParam httpOnly(boolean httpOnly);
public SetCookieParam secure(boolean secure);
public SetCookieParam sameSite(String sameSite);
public SetCookieParam expiry(long expiry);
}
class SourceLocation {
public SourceLocation(String url, int lineNumber, int columnNumber);
public String url();
public int lineNumber();
public int columnNumber();
}
class StartOptions {
public StartOptions engine(String engine);
public String engine();
public StartOptions channel(String channel);
public String channel();
public StartOptions headless(boolean headless);
public boolean headless();
public StartOptions userDataDir(String userDataDir);
public String userDataDir();
public StartOptions executablePath(String path);
public String executablePath();
public StartOptions connectURL(String url);
public String connectURL();
public StartOptions connectHeaders(Map<String, String> headers);
public Map<String, String> connectHeaders();
public StartOptions connectCaps(String capsJson);
public String connectCaps();
}
class StorageState {
public List<Cookie> cookies();
public List<OriginState> origins();
}
class ViewportSize {
public ViewportSize(int width, int height);
public int width();
public int height();
}
class WaitOptions {
public WaitOptions timeout(long timeout);
public Long timeout();
}
class WindowInfo {
public String state();
public int width();
public int height();
public int x();
public int y();
}
class WindowOptions {
public WindowOptions width(int width);
public WindowOptions height(int height);
public WindowOptions x(int x);
public WindowOptions y(int y);
public WindowOptions state(String state);
}