For AI agents: a documentation index is available at /llms.txt
Skip to main content

/chromium/agent

GET 

/chromium/agent

WebSocket endpoint for agentic browser interaction. Connect to establish a persistent browser session, then send JSON-RPC messages to control the browser.

Uses a simple JSON protocol instead of GraphQL: Send: { "id": 1, "method": "goto", "params": { "url": "https://example.com" } } Receive: { "id": 1, "result": { "status": 200, "url": "https://example.com" } }

All BQL mutations are available as methods (goto, click, type, screenshot, etc.). Additionally supports a "snapshot" method that returns interactive page elements with CSS selectors, plus tab-management methods (getTabs, switchTab, createTab, closeTab) for multi-tab workflows.

Request​

Query Parameters

    allowedDomains string[]
    blockAds boolean
    blockAdsInclude string
    blockConsentModals boolean
    credentials object
    deviceScaleFactor number
    deviceSlot number
    deviceType string

    Possible values: [phone, tablet]

    emulatedDevice string
    emulationOs Platform

    Possible values: [android, ios, linux, macos, windows]

    externalProxyServer string
    humanlike boolean
    integrationId string
    launch object
    profile string
    proxy ProxyType

    Possible values: [datacenter, residential]

    proxyCity string
    proxyCountry string
    proxyLocaleMatch string

    Possible values: [0, 1, false, true]

    proxyPreset string
    proxyState string
    proxySticky string

    Possible values: [0, 1, false, true]

    record boolean
    replay boolean
    screen string
    sessionId string
    timeout number
    token string
    trackingId string

Responses​

Indicates successful WebSocket upgrade.

Was this page helpful?