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

/chromium/agent/capabilities

GET 

/chromium/agent/capabilities

Returns the versioned capabilities declared by the Chromium agent route. Supply the intended route query parameters so authentication and plan checks can reject unsupported combinations before a browser is allocated.

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​

Schema
    versionnumberrequired
    Constant value: 1
    Default value: 1
    routestringrequired
    Constant value: /chromium/agent
    capabilities objectrequired
    vision objectrequired
    availablebooleanrequired
    Constant value: true
    Default value: true
    primitives[]required

    Possible values: >= 2, <= 2

    Default value: ["screenshot","viewport"]
    availableAt[]required

    Possible values: >= 1, <= 1

    os-spoofing objectrequired
    availablebooleanrequired
    Constant value: true
    Default value: true
    queryParameters[]required

    Possible values: >= 1, <= 1

    Default value: ["emulationOs"]
    availableAt[]required

    Possible values: >= 2, <= 2

    datacenter-proxy objectrequired
    availablebooleanrequired
    Constant value: true
    Default value: true
    queryParameters[]required

    Possible values: >= 1, <= 1

    Default value: ["proxy"]
    values[]required

    Possible values: >= 1, <= 1

    Default value: ["datacenter"]
    availableAt[]required

    Possible values: >= 2, <= 2

    secret-capture objectrequired
    availablebooleanrequired
    Constant value: true
    Default value: true
    primitives[]required

    Possible values: >= 6, <= 6

    Default value: ["loadSecret","saveSecret","clearSecrets","goto","screenshot","snapshot"]
    orderingstringrequired
    Constant value: Run screenshots and snapshots before loadSecret, or explicitly run clearSecrets once secret-bearing content is gone from all tabs before capturing. Navigation does not clear capture protection. An accepted clearSecrets invalidates snapshots already in flight; request a fresh snapshot after unlocking. saveSecret is not gated by the capture gate and may run at any point.
    Default value: Run screenshots and snapshots before loadSecret, or explicitly run clearSecrets once secret-bearing content is gone from all tabs before capturing. Navigation does not clear capture protection. An accepted clearSecrets invalidates snapshots already in flight; request a fresh snapshot after unlocking. saveSecret is not gated by the capture gate and may run at any point.
    availableAt[]required

    Possible values: >= 1, <= 1

Was this page helpful?