Skip to main content
POST
browser.page.navigate

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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})$
url
string
required

Page to load. A public http or https URL (private and local addresses are refused), or the literal about:blank.

Maximum string length: 2048
settleMs
integer
default:1000

Extra wait after the page starts loading before the title is read, 0 to 10000 milliseconds. Default 1,000.

Required range: 0 <= x <= 10000

Response

The result

url
string
required

The address the session shows after the load.

title
string

The page's title.