Skip to main content
POST
browser.page.wait

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by browser.session.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
selector
string

CSS selector of the element to wait for. Send this or load.

Required string length: 1 - 256
state
enum<string>
default:visible

With selector: the state to wait for. Default visible.

Available options:
attached,
detached,
visible,
hidden
load
enum<string>

Wait for the page to reach this load state instead of an element.

Available options:
domcontentloaded,
load,
networkidle
timeoutMs
integer
default:10000

How long to wait, 1 to 10000 ms. Default 10000.

Required range: 1 <= x <= 10000

Response

The result

matched
boolean
required

True when the condition came true before the time ran out.

url
string

The address the session shows.

title
string

The page's title.