API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Browser Rendering

Browser RenderingContent

Get HTML content.

browser_rendering.content.create(ContentCreateParams**kwargs) -> ContentCreateResponse

POST/accounts/{account_id}/browser-rendering/content

ModelsExpand Collapse

str

HTML content.

Browser RenderingPDF

Get PDF.

browser_rendering.pdf.create(PDFCreateParams**kwargs) -> BinaryResponseContent

POST/accounts/{account_id}/browser-rendering/pdf

Browser RenderingScrape

Scrape elements.

browser_rendering.scrape.create(ScrapeCreateParams**kwargs) -> ScrapeCreateResponse

POST/accounts/{account_id}/browser-rendering/scrape

ModelsExpand Collapse

List[ScrapeCreateResponseItem]

results: ScrapeCreateResponseItemResults

attributes: List[ScrapeCreateResponseItemResultsAttribute]

name: str

Attribute name.

value: str

Attribute value.

height: float

Element height.

html: str

HTML content.

left: float

Element left.

text: str

Text content.

top: float

Element top.

width: float

Element width.

selector: str

Selector.

Browser RenderingScreenshot

Get screenshot.

browser_rendering.screenshot.create(ScreenshotCreateParams**kwargs) -> ScreenshotCreateResponse

POST/accounts/{account_id}/browser-rendering/screenshot

ModelsExpand Collapse

class ScreenshotCreateResponse: …

success: bool

Response status.

errors: Optional[List[Error]]

code: float

Error code.

message: str

Error message.

Browser RenderingSnapshot

Get HTML content and screenshot.

browser_rendering.snapshot.create(SnapshotCreateParams**kwargs) -> SnapshotCreateResponse

POST/accounts/{account_id}/browser-rendering/snapshot

ModelsExpand Collapse

class SnapshotCreateResponse: …

content: str

HTML content.

screenshot: str

Base64 encoded image.

Browser RenderingJson

Get json.

browser_rendering.json.create(JsonCreateParams**kwargs) -> JsonCreateResponse

POST/accounts/{account_id}/browser-rendering/json

ModelsExpand Collapse

Dict[str, Optional[object]]

Browser RenderingLinks

Get Links.

browser_rendering.links.create(LinkCreateParams**kwargs) -> LinkCreateResponse

POST/accounts/{account_id}/browser-rendering/links

ModelsExpand Collapse

List[str]

Browser RenderingMarkdown

Get markdown.

browser_rendering.markdown.create(MarkdownCreateParams**kwargs) -> MarkdownCreateResponse

POST/accounts/{account_id}/browser-rendering/markdown

ModelsExpand Collapse

str

Markdown content.

Browser RenderingCrawl

Crawl websites.

browser_rendering.crawl.create(CrawlCreateParams**kwargs) -> CrawlCreateResponse

POST/accounts/{account_id}/browser-rendering/crawl

Get crawl result.

browser_rendering.crawl.get(strjob_id, CrawlGetParams**kwargs) -> CrawlGetResponse

GET/accounts/{account_id}/browser-rendering/crawl/{job_id}

Cancel a crawl job.

browser_rendering.crawl.delete(strjob_id, CrawlDeleteParams**kwargs) -> CrawlDeleteResponse

DELETE/accounts/{account_id}/browser-rendering/crawl/{job_id}

ModelsExpand Collapse

str

Crawl job ID.

class CrawlGetResponse: …

id: str

Crawl job ID.

browser_seconds_used: float

Total seconds spent in browser so far.

finished: float

Total number of URLs that have been crawled so far.

records: List[Record]

List of crawl job records.

metadata: RecordMetadata

status: float

HTTP status code of the crawled page.

url: str

Final URL of the crawled page.

title: Optional[str]

Title of the crawled page.

status: Literal["queued", "errored", "completed", 3 more]

Current status of the crawled URL.

One of the following:

"queued"

"errored"

"completed"

"disallowed"

"skipped"

"cancelled"

url: str

Crawled URL.

html: Optional[str]

HTML content of the crawled URL.

json: Optional[Dict[str, Optional[object]]]

JSON of the content of the crawled URL.

markdown: Optional[str]

Markdown of the content of the crawled URL.

skipped: float

Total number of URLs that were skipped due to include/exclude/subdomain filters. Skipped URLs are included in records but are not counted toward total/finished.

status: str

Current crawl job status.

total: float

Total current number of URLs in the crawl job.

cursor: Optional[str]

Cursor for pagination.

class CrawlDeleteResponse: …

job_id: str

The ID of the cancelled job.

message: str

Cancellation confirmation message.

Browser RenderingDevtools

Browser RenderingDevtoolsSession

List sessions.

browser_rendering.devtools.session.list(SessionListParams**kwargs) -> SessionListResponse

GET/accounts/{account_id}/browser-rendering/devtools/session

Get session details.

browser_rendering.devtools.session.get(strsession_id, SessionGetParams**kwargs) -> SessionGetResponse

GET/accounts/{account_id}/browser-rendering/devtools/session/{session_id}

ModelsExpand Collapse

List[SessionListResponseItem]

session_id: str

Session ID.

formatuuid

close_reason: Optional[str]

Reason for session closure.

close_reason_text: Optional[str]

Human-readable close reason.

connection_end_time: Optional[float]

Connection end time.

connection_id: Optional[str]

Connection ID.

connection_start_time: Optional[float]

Connection start time.

devtools_frontend_url: Optional[str]

DevTools frontend URL.

end_time: Optional[float]

Session end time.

last_updated: Optional[float]

Last updated timestamp.

start_time: Optional[float]

Session start time.

web_socket_debugger_url: Optional[str]

WebSocket URL for debugging this target.

class SessionGetResponse: …

session_id: str

Session ID.

formatuuid

close_reason: Optional[str]

Reason for session closure.

close_reason_text: Optional[str]

Human-readable close reason.

connection_end_time: Optional[float]

Connection end time.

connection_id: Optional[str]

Connection ID.

connection_start_time: Optional[float]

Connection start time.

devtools_frontend_url: Optional[str]

DevTools frontend URL.

end_time: Optional[float]

Session end time.

last_updated: Optional[float]

Last updated timestamp.

start_time: Optional[float]

Session start time.

web_socket_debugger_url: Optional[str]

WebSocket URL for debugging this target.

Browser RenderingDevtoolsBrowser

Get a browser session ID.

browser_rendering.devtools.browser.create(BrowserCreateParams**kwargs) -> BrowserCreateResponse

POST/accounts/{account_id}/browser-rendering/devtools/browser

Acquire and connect to browser session.

browser_rendering.devtools.browser.launch(BrowserLaunchParams**kwargs)

GET/accounts/{account_id}/browser-rendering/devtools/browser

Connect to browser session.

browser_rendering.devtools.browser.connect(strsession_id, BrowserConnectParams**kwargs)

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}

Close browser session.

browser_rendering.devtools.browser.delete(strsession_id, BrowserDeleteParams**kwargs) -> BrowserDeleteResponse

DELETE/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}

Get browser version metadata.

browser_rendering.devtools.browser.version(strsession_id, BrowserVersionParams**kwargs) -> BrowserVersionResponse

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/version

Get Chrome DevTools Protocol schema.

browser_rendering.devtools.browser.protocol(strsession_id, BrowserProtocolParams**kwargs) -> BrowserProtocolResponse

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/protocol

ModelsExpand Collapse

class BrowserCreateResponse: …

session_id: str

Browser session ID.

web_socket_debugger_url: Optional[str]

WebSocket URL for the session.

class BrowserDeleteResponse: …

status: Literal["closing", "closed"]

One of the following:

"closing"

"closed"

class BrowserVersionResponse: …

browser: str

Browser name and version.

protocol_version: str

Chrome DevTools Protocol version.

user_agent: str

User agent string.

v8_version: str

V8 JavaScript engine version.

web_kit_version: str

WebKit version.

web_socket_debugger_url: str

WebSocket URL for debugging the browser.

class BrowserProtocolResponse: …

domains: List[Domain]

List of protocol domains.

domain: str

Domain name.

commands: Optional[List[Dict[str, Optional[object]]]]

Available commands.

dependencies: Optional[List[str]]

Domain dependencies.

events: Optional[List[Dict[str, Optional[object]]]]

Available events.

experimental: Optional[bool]

Whether this domain is experimental.

types: Optional[List[Dict[str, Optional[object]]]]

Type definitions.

version: Optional[Version]

Protocol version.

major: str

Major version.

minor: str

Minor version.

Browser RenderingDevtoolsBrowserPage

Connect to a specific Chrome DevTools page.

browser_rendering.devtools.browser.page.get(strtarget_id, PageGetParams**kwargs)

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/page/{target_id}

Browser RenderingDevtoolsBrowserTargets

Open a new browser tab.

browser_rendering.devtools.browser.targets.create(strsession_id, TargetCreateParams**kwargs) -> TargetCreateResponse

PUT/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/new

List targets.

browser_rendering.devtools.browser.targets.list(strsession_id, TargetListParams**kwargs) -> TargetListResponse

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list

Get a target by ID.

browser_rendering.devtools.browser.targets.get(strtarget_id, TargetGetParams**kwargs) -> TargetGetResponse

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list/{target_id}

Activate a browser target.

browser_rendering.devtools.browser.targets.activate(strtarget_id, TargetActivateParams**kwargs) -> TargetActivateResponse

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/activate/{target_id}

ModelsExpand Collapse

class TargetCreateResponse: …

id: str

Target ID.

type: str

Target type (page, background_page, worker, etc.).

url: str

URL of the target.

description: Optional[str]

Target description.

devtools_frontend_url: Optional[str]

DevTools frontend URL.

title: Optional[str]

Title of the target.

web_socket_debugger_url: Optional[str]

WebSocket URL for debugging this target.

List[TargetListResponseItem]

id: str

Target ID.

type: str

Target type (page, background_page, worker, etc.).

url: str

URL of the target.

description: Optional[str]

Target description.

devtools_frontend_url: Optional[str]

DevTools frontend URL.

title: Optional[str]

Title of the target.

web_socket_debugger_url: Optional[str]

WebSocket URL for debugging this target.

class TargetGetResponse: …

id: str

Target ID.

type: str

Target type (page, background_page, worker, etc.).

url: str

URL of the target.

description: Optional[str]

Target description.

devtools_frontend_url: Optional[str]

DevTools frontend URL.

title: Optional[str]

Title of the target.

web_socket_debugger_url: Optional[str]

WebSocket URL for debugging this target.

class TargetActivateResponse: …

message: str

Target activated.