Skip to content

API Matrix

Every operation Vibium supports (235 in all) and its form on each surface. An empty cell means the surface has no equivalent. The source is the API spec in the main repository, which CI checks against the binary and all three clients.

Operations marked (nightly) are not in the latest release (26.11.16). The same data is published as /api.json. Per-language views: JavaScript, Python, Java.

OperationCLIMCPJavaScriptPythonJava
Launch browser and connectvibium startbrowser_startbrowser.start(opts?)browser.start(opts?)Vibium.start(options?)
Get the default pagebrowser.page()browser.page()browser.page()
Create a new pagevibium page newbrowser_new_pagebrowser.newPage()browser.new_page()browser.newPage()
Create a new browser contextbrowser.newContext()browser.new_context()browser.newContext()
List all pagesvibium pagesbrowser_list_pagesbrowser.pages()browser.pages()browser.pages()
Stop the browservibium stopbrowser_stopbrowser.stop()browser.stop()browser.stop()
Listen for new page eventsbrowser.onPage(cb)browser.on_page(cb)browser.onPage(cb)
Listen for popup eventsbrowser.onPopup(cb)browser.on_popup(cb)browser.onPopup(cb)
Remove all event listenersbrowser.removeAllListeners(ev?)browser.remove_all_listeners(ev?)browser.removeAllListeners(ev?)
Get the default contextbrowser.context()
OperationCLIMCPJavaScriptPythonJava
Navigate to a URLvibium go <url>browser_navigatepage.go(url)page.go(url)page.go(url)
Go backvibium backbrowser_backpage.back()page.back()page.back()
Go forwardvibium forwardbrowser_forwardpage.forward()page.forward()page.forward()
Reload pagevibium reloadbrowser_reloadpage.reload()page.reload()page.reload()
Get current URLvibium urlbrowser_get_urlpage.url()page.url()page.url()
Get page titlevibium titlebrowser_get_titlepage.title()page.title()page.title()
Get page HTMLpage.content()page.content()page.content()
Find a single element by description (a bare string), css, tag, semantic locator, or reference image; strategy auto, cv, vlm, or treevibium find <description>browser_findpage.find(locator, opts?)page.find(locator, **opts)page.find(locator, options?)
Find all matching elements, same locator formsvibium find --all <description>browser_find_allpage.findAll(locator, opts?)page.find_all(locator, **opts)page.findAll(locator, options?)
Take a page screenshotvibium screenshotbrowser_screenshotpage.screenshot(opts?)page.screenshot(opts?)page.screenshot(options?)
Generate PDFvibium pdfbrowser_pdfpage.pdf(opts?)page.pdf(**opts)page.pdf(options?)
Evaluate JavaScriptvibium eval <expr>browser_evaluatepage.evaluate(expr)page.evaluate(expr)page.evaluate(expr)
Add a script tagpage.addScript(src)page.add_script(src)page.addScript(src)
Add a style tagpage.addStyle(src)page.add_style(src)page.addStyle(src)
Expose a function to the pagepage.expose(name, fn)page.expose(name, fn)page.expose(name, fn)
Wait for a durationvibium sleep <ms>browser_sleeppage.wait(ms)page.wait(ms)page.sleep(ms)
Wait for a selectorvibium wait <sel>browser_waitpage.waitFor(sel, options?)
Wait for JS function to return truthyvibium wait fn <expr>browser_wait_for_fnpage.waitForFunction(fn, opts?)page.wait_for_function(fn, **opts)page.waitForFunction(fn, options?)
Wait for URL to matchvibium wait url <pat>browser_wait_for_urlpage.waitForURL(url, opts?)page.wait_for_url(url, **opts)page.waitForURL(url, options?)
Wait for page loadvibium wait loadbrowser_wait_for_loadpage.waitForLoad(opts?)page.wait_for_load(**opts)page.waitForLoad(options?)
Scroll the pagevibium scroll <dir> <amt>browser_scrollpage.scroll(dir?, amt?, sel?)page.scroll(dir?, amt?, sel?)page.scroll(options?)
Set viewport sizevibium viewport <w> <h>browser_set_viewportpage.setViewport(size)page.set_viewport(size)page.setViewport(size)
Get viewport sizevibium viewportbrowser_get_viewportpage.viewport()page.viewport()page.viewport()
Override CSS media featuresvibium media <scheme>browser_emulate_mediapage.emulateMedia(opts)page.emulate_media(**opts)page.emulateMedia(opts)
Set page HTMLvibium content <html>browser_set_contentpage.setContent(html)page.set_content(html)page.setContent(html)
Override geolocationvibium geolocation <lat> <lon>browser_set_geolocationpage.setGeolocation(coords)page.set_geolocation(coords)page.setGeolocation(coords)
Set window size/positionvibium window <opts>browser_set_windowpage.setWindow(opts)page.set_window(**opts)page.setWindow(opts)
Get window infovibium windowbrowser_get_windowpage.window()page.window()page.window()
Get accessibility treevibium a11y-treebrowser_a11y_treepage.a11yTree(opts?)page.a11y_tree(opts?)page.a11yTree(options?)
List all framesvibium framesbrowser_framespage.frames()page.frames()page.frames()
Get a frame by name/URLvibium frame <ref>browser_framepage.frame(nameOrUrl)page.frame(name_or_url)page.frame(nameOrUrl)
Get the main framepage.mainFrame()page.main_frame()page.mainFrame()
Bring page to frontvibium page switch <idx>browser_switch_pagepage.bringToFront()page.bring_to_front()page.bringToFront()
Close the pagevibium page closebrowser_close_pagepage.close()page.close()page.close()
Register a route handlerpage.route(pattern, handler)page.route(pattern, handler)page.route(pattern, handler)
Remove a route handlerpage.unroute(pattern)page.unroute(pattern)page.unroute(pattern)
Set extra HTTP headerspage.setHeaders(headers)page.set_headers(headers)page.setHeaders(headers)
Listen for requestspage.onRequest(fn)page.on_request(fn)page.onRequest(fn)
Listen for responsespage.onResponse(fn)page.on_response(fn)page.onResponse(fn)
Listen for dialogspage.onDialog(fn)page.on_dialog(fn)page.onDialog(fn)
Listen for console messagespage.onConsole(fn)page.on_console(fn)page.onConsole(fn)
Listen for page errorspage.onError(fn)page.on_error(fn)page.onError(fn)
Listen for downloadspage.onDownload(fn)page.on_download(fn)page.onDownload(fn)
Subscribe to WebSocket eventspage.onWebSocket(fn)page.on_web_socket(fn)page.onWebSocket(fn)
Remove all event listenerspage.removeAllListeners(ev?)page.remove_all_listeners(ev?)page.removeAllListeners(ev?)
Capture response (before action)page.capture.response(pat, fn?)page.capture.response(pat, fn?)page.capture().response(pat, action)
Capture request (before action)page.capture.request(pat, fn?)page.capture.request(pat, fn?)page.capture().request(pat, action)
Capture navigation (before action)page.capture.navigation(fn?)page.capture.navigation(fn?)page.capture().navigation(action)
Capture event (before action)page.capture.event(name, fn?)page.capture.event(name, fn?)page.capture().event(name, action)
Capture download (before action)page.capture.download(fn?)page.capture.download(fn?)page.capture().download(action)
Capture dialog (before action)page.capture.dialog(fn?)page.capture.dialog(fn?)page.capture().dialog(action)
Get buffered console messagespage.consoleMessages()page.console_messages()page.consoleMessages()
Get buffered page errorspage.errors()page.errors()page.errors()
Owning browser contextpage.contextpage.contextpage.context()
Browsing context idpage.idpage.idpage.id()
One-shot capture namespacepage.capturepage.capturepage.capture()
Keyboard input for the pagepage.keyboardpage.keyboardpage.keyboard()
Mouse input for the pagepage.mousepage.mousepage.mouse()
Touch input for the pagepage.touchpage.touchpage.touch()
Clock control for the pagepage.clockpage.clockpage.clock()
Deprecated alias for the wait helperspage.waitUntil(fn, opts?)page.wait_until
Enable console collect modemode of onConsole(‘collect’)mode of on_console(‘collect’)page.collectConsole()
Enable error collect modemode of onError(‘collect’)mode of on_error(‘collect’)page.collectErrors()
Intercept WebSockets (unsupported: throws)page.routeWebSocket(pattern, fn)
Alias for evaluatepage.eval(expr)
OperationCLIMCPJavaScriptPythonJava
Click an elementvibium click <sel>browser_clickel.click(opts?)el.click(timeout?)el.click()
Double-click an elementvibium dblclick <sel>browser_dblclickel.dblclick(opts?)el.dblclick(timeout?)el.dblclick()
Fill an input fieldvibium fill <sel> <val>browser_fillel.fill(value, opts?)el.fill(value, timeout?)el.fill(value)
Type text character by charactervibium type <text>browser_typeel.type(text, opts?)el.type(text, timeout?)el.type(text)
Press a key on focused elementvibium press <key>browser_pressel.press(key, opts?)el.press(key, timeout?)el.press(key)
Clear an input fieldel.clear(opts?)el.clear(timeout?)el.clear()
Check a checkboxvibium set <sel>browser_setel.set(value?, opts?)el.set(value=True, timeout=...)el.set(value?)
Uncheck a checkboxvibium unset <sel>browser_unsetel.unset(opts?)el.unset(timeout?)el.unset()
Select a dropdown optionvibium select <sel> <val>browser_selectel.selectOption(val, opts?)el.select_option(val, timeout?)el.selectOption(val)
Hover over an elementvibium hover <sel>browser_hoverel.hover(opts?)el.hover(timeout?)el.hover()
Focus an elementvibium focus <sel>browser_focusel.focus(opts?)el.focus(timeout?)el.focus()
Drag an element to a targetvibium drag <sel> <x> <y>browser_dragel.dragTo(target, opts?)el.drag_to(target, timeout?)el.dragTo(target)
Tap an element (touch)el.tap(opts?)el.tap(timeout?)el.tap()
Scroll element into viewvibium scroll into-view <sel>browser_scroll_into_viewel.scrollIntoView(opts?)el.scroll_into_view(timeout?)el.scrollIntoView()
Dispatch a DOM eventel.dispatchEvent(type, init?)el.dispatch_event(type, init?)el.dispatchEvent(type, init?)
Set files on a file inputvibium upload <sel> <paths>browser_uploadel.setFiles(files, opts?)el.set_files(files, timeout?)el.setFiles(files)
Highlight an elementvibium highlight <sel>browser_highlightel.highlight()el.highlight()el.highlight()
Get element text contentvibium text <sel>browser_get_textel.text()el.text()el.text()
Get element inner textvibium text <sel>browser_get_textel.innerText()el.inner_text()el.innerText()
Get element outer HTMLvibium html <sel>browser_get_htmlel.html()el.html()el.html()
Get input element valuevibium value <sel>browser_get_valueel.value()el.value()el.value()
Get element attributevibium attr <sel> <name>browser_get_attributeel.attr(name)el.attr(name)el.attr(name)
Get element bounding boxel.bounds()el.bounds()el.bounds()
Bounding box (Playwright-compat alias for bounds)el.boundingBox()el.bounding_box()el.boundingBox()
Get attribute (alias for attr)el.getAttribute(name)el.get_attribute(name)el.getAttribute(name)
Find-time snapshot of tag, text, and boxel.infoel.infoel.info()
Check if element is visiblevibium is visible <sel>browser_is_visibleel.isVisible()el.is_visible()el.isVisible()
Check if element is hiddenel.isHidden()el.is_hidden()el.isHidden()
Check if element is enabledvibium is enabled <sel>browser_is_enabledel.isEnabled()el.is_enabled()el.isEnabled()
Check if element is checkedvibium is set <sel>browser_is_setel.isSet()el.is_set()el.isSet()
Check if element is editableel.isEditable()el.is_editable()el.isEditable()
Get element ARIA roleel.role()el.role()el.role()
Get element accessible labelel.label()el.label()el.label()
Screenshot an elementel.screenshot()el.screenshot()el.screenshot()
Wait for element statevibium wait <sel> --state <st>browser_waitel.waitUntil(state?, opts?)el.wait_until(state?, timeout?)el.waitUntil(state?, options?)
Find a child element (scoped)el.find(sel, opts?)el.find(sel, **opts)el.find(sel, options?)
Find all child elements (scoped)el.findAll(sel, opts?)el.find_all(sel, **opts)el.findAll(sel, options?)
OperationCLIMCPJavaScriptPythonJava
Create a page in a contextcontext.newPage()context.new_page()context.newPage()
Close the contextcontext.close()context.close()context.close()
Get cookiesvibium cookiesbrowser_get_cookiescontext.cookies(urls?)context.cookies(urls?)context.cookies(urls?)
Set cookiesvibium cookies <n> <v>browser_set_cookiecontext.setCookies(cookies)context.set_cookies(cookies)context.setCookies(cookies)
Clear cookiesvibium cookies clearbrowser_delete_cookiescontext.clearCookies()context.clear_cookies()context.clearCookies()
Get storage statevibium storagebrowser_storage_statecontext.storage()context.storage()context.storage()
Set storage statebrowser_restore_storagecontext.setStorage(state)context.set_storage(state)context.setStorage(state)
Clear all storagecontext.clearStorage()context.clear_storage()context.clearStorage()
Add an init scriptcontext.addInitScript(script)context.add_init_script(script)context.addInitScript(script)
User context idcontext.idcontext.idcontext.id()
Recording controls for the contextcontext.recordingcontext.recordingcontext.recording()
OperationCLIMCPJavaScriptPythonJava
Press a keyvibium keys <keys>browser_keyskeyboard.press(key)keyboard.press(key)keyboard.press(key)
Key downkeyboard.down(key)keyboard.down(key)keyboard.down(key)
Key upkeyboard.up(key)keyboard.up(key)keyboard.up(key)
Type textkeyboard.type(text)keyboard.type(text)keyboard.type(text)
OperationCLIMCPJavaScriptPythonJava
Click at coordinatesvibium mouse click <x> <y>browser_mouse_clickmouse.click(x, y, opts?)mouse.click(x, y, **opts)mouse.click(x, y, options?)
Move mousevibium mouse move <x> <y>browser_mouse_movemouse.move(x, y, opts?)mouse.move(x, y, **opts)mouse.move(x, y, options?)
Mouse button downvibium mouse downbrowser_mouse_downmouse.down(opts?)mouse.down(**opts)mouse.down(options?)
Mouse button upvibium mouse upbrowser_mouse_upmouse.up(opts?)mouse.up(**opts)mouse.up(options?)
Scroll mouse wheelmouse.wheel(dx, dy)mouse.wheel(dx, dy)mouse.wheel(dx, dy)
OperationCLIMCPJavaScriptPythonJava
Tap at coordinatesvibium tap <x> <y>browser_taptouch.tap(x, y)touch.tap(x, y)touch.tap(x, y)
Swipe in a direction (up, down, left, right; from an edge or point; speed, hold) or between coordinatesvibium swipe <direction>browser_swipetouch.swipe(direction, opts?)touch.swipe(direction, from_=, speed=, hold_ms=)
Long-press at coordinatesvibium long-press <x> <y>browser_long_presstouch.longPress(x, y, durationMs?)touch.long_press(x, y, duration_ms?)
OperationCLIMCPJavaScriptPythonJava
Install fake timerspage_clock_installclock.install(opts?)clock.install(time?, timezone?)clock.install(options?)
Fast-forward timepage_clock_fast_forwardclock.fastForward(ticks)clock.fast_forward(ticks)clock.fastForward(ticks)
Run timers for a durationpage_clock_run_forclock.runFor(ticks)clock.run_for(ticks)clock.runFor(ticks)
Pause clock at a timepage_clock_pause_atclock.pauseAt(time)clock.pause_at(time)clock.pauseAt(time)
Resume clockpage_clock_resumeclock.resume()clock.resume()clock.resume()
Set fixed fake timepage_clock_set_fixed_timeclock.setFixedTime(time)clock.set_fixed_time(time)clock.setFixedTime(time)
Set system timepage_clock_set_system_timeclock.setSystemTime(time)clock.set_system_time(time)clock.setSystemTime(time)
Set timezonepage_clock_set_timezoneclock.setTimezone(tz)clock.set_timezone(tz)clock.setTimezone(tz)
OperationCLIMCPJavaScriptPythonJava
Start recordingvibium record startbrowser_record_startrecording.start(opts?)recording.start(opts?)recording.start(options?)
Stop recording, return tracevibium record stopbrowser_record_stoprecording.stop(opts?)recording.stop(path?, upload?)recording.stop(path?)
Start a recording chunkvibium record chunk startbrowser_record_start_chunkrecording.startChunk(opts?)recording.start_chunk(opts?)recording.startChunk(options?)
Stop a recording chunkvibium record chunk stopbrowser_record_stop_chunkrecording.stopChunk(opts?)recording.stop_chunk(path?)recording.stopChunk(path?)
Start a logical groupvibium record group start <name>browser_record_start_grouprecording.startGroup(name, opts?)recording.start_group(name, location?)recording.startGroup(name, location?)
Stop a logical groupvibium record group stopbrowser_record_stop_grouprecording.stopGroup()recording.stop_group()recording.stopGroup()
OperationCLIMCPJavaScriptPythonJava
Access intercepted requestroute.request (property)route.request (property)route.request()
Fulfill an intercepted requestroute.fulfill(resp?)route.fulfill(status?, headers?, ...)route.fulfill(options?)
Continue an intercepted requestroute.continue(overrides?)route.continue_(overrides?)route.doContinue(options?)
Abort an intercepted requestroute.abort()route.abort()route.abort()
OperationCLIMCPJavaScriptPythonJava
Get dialog messagedialog.message()dialog.message()dialog.message()
Get dialog typedialog.type()dialog.type()dialog.type()
Get dialog default valuedialog.defaultValue()dialog.default_value()dialog.defaultValue()
Accept the dialogvibium dialog acceptbrowser_dialog_acceptdialog.accept(promptText?)dialog.accept(prompt_text?)dialog.accept(promptText?)
Dismiss the dialogvibium dialog dismissbrowser_dialog_dismissdialog.dismiss()dialog.dismiss()dialog.dismiss()
OperationCLIMCPJavaScriptPythonJava
Save a download to pathdownload.saveAs(path)download.save_as(path)download.saveAs(path)
Get download URLdownload.url()download.url()download.url()
Get download filenamedownload.suggestedFilename()download.suggested_filename()download.suggestedFilename()
Get download pathdownload.path()download.path()download.path()
OperationCLIMCPJavaScriptPythonJava
Get request URLrequest.url()request.url()request.url()
Get HTTP methodrequest.method()request.method()request.method()
Get request headersrequest.headers()request.headers()request.headers()
Get BiDi request IDrequest.requestId()request.request_id()request.requestId()
Get request bodyrequest.postData()request.post_data()request.postData()
OperationCLIMCPJavaScriptPythonJava
Get response URLresponse.url()response.url()response.url()
Get HTTP statusresponse.status()response.status()response.status()
Get response headersresponse.headers()response.headers()response.headers()
Get associated request IDresponse.requestId()response.request_id()response.requestId()
Get response bodyresponse.body()response.body()response.body()
Parse response body as JSONresponse.json()response.json()response.json()
OperationCLIMCPJavaScriptPythonJava
Get console message typemessage.type()message.type()message.type()
Get formatted message textmessage.text()message.text()message.text()
Get console argumentsmessage.args()message.args()message.args()
Get source locationmessage.location()message.location()message.location()
OperationCLIMCPJavaScriptPythonJava
Get WebSocket URLsocket.url()socket.url()socket.url()
Listen for messagessocket.onMessage(fn)socket.on_message(fn)socket.onMessage(fn)
Listen for closesocket.onClose(fn)socket.on_close(fn)socket.onClose(fn)
Check whether socket is closedsocket.isClosed()socket.is_closed()socket.isClosed()
OperationCLIMCPJavaScriptPythonJava
Map interactive page elements with @refsvibium mapbrowser_map
Diff page state vs last mapvibium diff mapbrowser_diff_map
Count elements matching selectorvibium count <sel>browser_count
Wait for text to appear on pagevibium wait text <text>browser_wait_for_text
Set the download directoryvibium download dir <path>browser_download_set_dir
Start the background daemonvibium daemon start
Query daemon statusvibium daemon status
Stop the background daemonvibium daemon stop
Print the versionvibium version
Print browser and cache pathsvibium paths
Download the browser enginevibium install
Check whether the engine is installedvibium is-installed
Run the BiDi websocket servervibium serve
Run the ndjson stdio transportvibium pipe
Run the MCP servervibium mcp
Install the agent skillvibium add-skill
Write a starter settings filevibium config init
Set up AI settings, agent skills, and the browser interactivelyvibium setup
Generate a script that replays a recordingvibium codegen -i <zip>
Generate an Ed25519 Web Bot Auth signing keyvibium webbotauth keygen
Print the Web Bot Auth JWKS directory to publishvibium webbotauth directory
Restore saved storage statevibium storage restore <path>
Print all actionability checksvibium is actionable <sel>
Find by ARIA rolevibium find role <val>
Find by visible textvibium find text <val>
Find by labelvibium find label <val>
Find by placeholdervibium find placeholder <val>
Find by alt textvibium find alt <val>
Find by title attributevibium find title <val>
Find by test idvibium find testid <val>
Find by XPathvibium find xpath <val>
Find by CSS selector, explicitlyvibium find css <val>
Find by HTML tagvibium find tag <val>
Find by description, explicitlyvibium find description <val>
Find where a reference image appearsvibium find image <path>
Diagnostic: launch the browser directlyvibium launch-test
Diagnostic: test a websocket endpointvibium ws-test <url>
Diagnostic: test a BiDi endpointvibium bidi-test <url>
OperationCLIMCPJavaScriptPythonJava
Independently verify the active session or a saved archivevibium check <claim>vibium_checkbrowser.check(claim, opts?)browser.check(claim, record=...)browser.check(claim, options?)
Independently verify a pinned page or a saved archivepage.check(claim, opts?)page.check(claim, record=...)page.check(claim, options?)
Check a saved archive without launching a browserVibium.check(claim, options)
Check browser installation and configured AI readinessvibium ready
Require AI configuration and provider tool supportvibium ready ai
Check local browser executable files without launchingvibium ready browser
Send one phrase through the say and listen providers, without a browservibium ready speech
Accomplish a goal in the active browser sessionvibium run <goal>vibium_runbrowser.run(goal, opts?)browser.run(goal, opts?)browser.run(goal, opts?)
Accomplish a goal on a pinned pagepage.run(goal, opts?)page.run(goal, opts?)page.run(goal, opts?)
OperationCLIMCPJavaScriptPythonJava
Speak text into the session, this machine’s speakers, or a WAV filevibium say <text>vibium_saybrowser.say(text, opts?)browser.say(text, target=...)browser.say(text, options?)
Speak text into a pinned pagepage.say(text, opts?)page.say(text, target=...)page.say(text, options?)
Hear the session, this machine’s microphone, or a WAV file, and return a transcriptvibium listenvibium_listenbrowser.listen(opts?)browser.listen(target=...)browser.listen(options?)
Hear a pinned page and return a transcriptpage.listen(opts?)page.listen(target=...)page.listen(options?)
Speak with no browser, into this machine’s speakers or a WAV fileVibium.say(text, options?)
Listen with no browser, to this machine’s microphone or a WAV fileVibium.listen(options?)