Skip to main content
POST
browser.page.read-markdown

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 part of the page to read. Default: the whole page.

Required string length: 1 - 256
maxChars
integer
default:20000

Cut the Markdown at this many characters, 1 to 100000. Default 20000.

Required range: 1 <= x <= 100000

Response

The result

markdown
string
required

The page as Markdown, cleaned and capped.

title
string

The page's title.

url
string

The address the session shows.

truncated
boolean

Present when the Markdown was cut at maxChars.