Cloudflare Browser Run API reference

New to Corsair? See API access, authentication, and error handling.

Accessibility Tree

capture

accessibilityTree.capture Capture a page accessibility tree: https://developers.cloudflare.com/browser-run/quick-actions/accessibility-tree-endpoint/. Risk: read

await corsair.cloudflarebrowserrendering.api.accessibilityTree.capture({
	accountId: 'acct-123',
	body: { url: 'https://example.com', interestingOnly: true },
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string,
  interestingOnly?: boolean,
  root?: string
}

Output

Name	Type	Required	Description
`accessibilityTree`	`object \| null`	Yes	—

accessibilityTree full type

{
  role: string
} | null

Browser

close

browser.close Close a Browser Rendering session: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/methods/delete/. Risk: write

await corsair.cloudflarebrowserrendering.api.browser.close({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—

Output

Name	Type	Required	Description
`status`	`string`	Yes	—

create

browser.create Acquire a browser session with optional guardrails: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/methods/create/. Risk: destructive

await corsair.cloudflarebrowserrendering.api.browser.create({
	accountId: 'acct-123',
	keepAlive: 60000,
	lab: true,
	liveViewUrlExpiresInMs: 120000,
	recording: true,
	targets: true,
	guardrails: {
		allowedDomains: ['example.com'],
	},
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`keepAlive`	`number`	No	—
`lab`	`boolean`	No	—
`liveViewUrlExpiresInMs`	`number`	No	—
`recording`	`boolean`	No	—
`targets`	`boolean`	No	—
`guardrails`	`object`	No	—

guardrails full type

{
  allowedDomains?: string[],
  allowedDomainSets?: string[]
}

Output

Name	Type	Required	Description
`sessionId`	`string`	Yes	—
`webSocketDebuggerUrl`	`string`	No	—

liveView.create

browser.liveView.create Mint time-limited browser live-view URLs: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/live_view/methods/create/. Risk: write

await corsair.cloudflarebrowserrendering.api.browser.liveView.create({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', expiresInMs: 300000, guardrails: { mode: 'readonly' }, mode: 'tab', targetId: 'target-123' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—
`expiresInMs`	`number`	No	—
`guardrails`	`object`	No	—
`mode`	`devtools \| tab \| full`	No	—
`targetId`	`string`	No	—

guardrails full type

{
  mode: readonly
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`devtoolsFrontendUrl`	`string`	Yes	—
`options`	`object`	Yes	—
`webSocketDebuggerUrl`	`string`	Yes	—

options full type

{
  mode: string,
  guardrails?: {
    mode: string
  }
}

protocol

browser.protocol Retrieve the dynamic Chrome DevTools Protocol schema: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/methods/protocol/. Risk: read

await corsair.cloudflarebrowserrendering.api.browser.protocol({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—

Output

Name	Type	Required	Description
`domains`	`object[]`	Yes	—
`version`	`object`	No	—

domains full type

{
  domain: string,
  commands?: Record<string, JsonValue>[],
  dependencies?: string[],
  events?: Record<string, JsonValue>[],
  experimental?: boolean,
  types?: Record<string, JsonValue>[]
}[]

version full type

{
  major: string,
  minor: string
}

version

browser.version Get browser and DevTools version metadata: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/methods/version/. Risk: read

await corsair.cloudflarebrowserrendering.api.browser.version({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—

Output

Name	Type	Required	Description
`Browser`	`string`	Yes	—
`Protocol-Version`	`string`	Yes	—
`User-Agent`	`string`	Yes	—
`V8-Version`	`string`	Yes	—
`WebKit-Version`	`string`	Yes	—
`webSocketDebuggerUrl`	`string`	Yes	—

Content

fetch

content.fetch Fetch rendered HTML through Browser Run Quick Actions: https://developers.cloudflare.com/browser-run/quick-actions/content-endpoint/. Risk: read

await corsair.cloudflarebrowserrendering.api.content.fetch({
	accountId: 'acct-123',
	body: { url: 'https://example.com' },
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string
}

Output: string

Crawl

cancel

crawl.cancel Cancel an active crawl job: https://developers.cloudflare.com/browser-run/quick-actions/crawl-endpoint/. Risk: write

await corsair.cloudflarebrowserrendering.api.crawl.cancel({ accountId: 'acct-123', jobId: 'job-123' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`jobId`	`string`	Yes	—

Output

Name	Type	Required	Description
`job_id`	`string`	Yes	—
`message`	`string`	Yes	—

get

crawl.get Get crawl status or paginated results: https://developers.cloudflare.com/browser-run/quick-actions/crawl-endpoint/. Risk: read

await corsair.cloudflarebrowserrendering.api.crawl.get({ accountId: 'acct-123', jobId: 'job-123', cursor: '10', limit: 10, status: 'completed' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`jobId`	`string`	Yes	—
`cursor`	`string \| number`	No	—
`limit`	`number`	No	—
`status`	`queued \| completed \| disallowed \| skipped \| errored \| cancelled`	No	—

Output

Name	Type	Required	Description
`browserSecondsUsed`	`number`	Yes	—
`finished`	`number`	Yes	—
`id`	`string`	Yes	—
`records`	`object[]`	Yes	—
`robots`	`object[]`	No	—
`skipped`	`number`	No	—
`status`	`string`	Yes	—
`total`	`number`	Yes	—
`cursor`	`string \| number`	No	—

records full type

{
  status: string,
  url: string,
  html?: string,
  json?: Record<string, JsonValue>,
  markdown?: string,
  metadata?: {
    status: number,
    url: string,
    lastModified?: string,
    title?: string
  },
  outcome?: string
}[]

robots full type

{
  origin: string,
  state: string,
  status?: number
}[]

start

crawl.start Start an asynchronous site crawl: https://developers.cloudflare.com/browser-run/quick-actions/crawl-endpoint/. Risk: destructive

await corsair.cloudflarebrowserrendering.api.crawl.start({
	accountId: 'acct-123',
	body: { url: 'https://example.com', limit: 3, source: 'links' },
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  url: string,
  browser?: kitesurf,
  depth?: number,
  formats?: (html | markdown | json)[],
  crawlPurposes?: (search | ai-input | ai-train)[],
  contentUse?: reference | full,
  jsonOptions?: {
    custom_ai?: {
      authorization?: string,
      model: string
    }[],
    prompt?: string,
    response_format?: {
      type: json_schema,
      json_schema: Record<string, JsonValue>
    }
  },
  limit?: number,
  maxAge?: number,
  modifiedSince?: number,
  options?: {
    includeExternalLinks?: boolean,
    includePatterns?: string[],
    excludePatterns?: string[],
    includeSubdomains?: boolean
  },
  render?: boolean,
  source?: all | sitemaps | links
}

Output: string

Json

extract

json.extract Extract structured page data using a prompt or JSON schema: https://developers.cloudflare.com/browser-run/quick-actions/json-endpoint/. Risk: read

await corsair.cloudflarebrowserrendering.api.json.extract({
	accountId: 'acct-123',
	body: { url: 'https://example.com', prompt: 'Extract the page title and a short summary as JSON.' },
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string,
  custom_ai?: {
    authorization?: string,
    model: string
  }[],
  prompt?: string,
  response_format?: {
    type: json_schema,
    json_schema: Record<string, JsonValue>
  }
}

Output: Record<string, JsonValue>

Links

list

links.list Retrieve links from a rendered page: https://developers.cloudflare.com/browser-run/quick-actions/links-endpoint/. Risk: read

await corsair.cloudflarebrowserrendering.api.links.list({
	accountId: 'acct-123',
	body: { url: 'https://example.com' },
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string,
  excludeExternalLinks?: boolean,
  visibleLinksOnly?: boolean
}

Output: string[]

Markdown

convert

markdown.convert Convert rendered page content to Markdown: https://developers.cloudflare.com/browser-run/quick-actions/markdown-endpoint/. Risk: read

await corsair.cloudflarebrowserrendering.api.markdown.convert({
	accountId: 'acct-123',
	body: { url: 'https://example.com' },
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string
}

Output: string

Pdf

render

pdf.render Render a page to JSON-safe base64 PDF data: https://developers.cloudflare.com/browser-run/quick-actions/pdf-endpoint/. Risk: destructive

await corsair.cloudflarebrowserrendering.api.pdf.render({ accountId: 'acct-123', browser: 'kitesurf', cacheTTL: 0, body: { url: 'https://example.com', pdfOptions: { format: 'a4' } } });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`browser`	`kitesurf`	No	—
`cacheTTL`	`number`	No	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string,
  pdfOptions?: {
    displayHeaderFooter?: boolean,
    footerTemplate?: string,
    format?: letter | legal | tabloid | ledger | a0 | a1 | a2 | a3 | a4 | a5 | a6,
    headerTemplate?: string,
    height?: string | number,
    landscape?: boolean,
    margin?: {
      bottom?: string | number,
      left?: string | number,
      right?: string | number,
      top?: string | number
    },
    omitBackground?: boolean,
    outline?: boolean,
    pageRanges?: string,
    preferCSSPageSize?: boolean,
    printBackground?: boolean,
    scale?: number,
    tagged?: boolean,
    timeout?: number,
    width?: string | number
  }
}

Output

Name	Type	Required	Description
`contentType`	`string`	Yes	—
`byteLength`	`number`	Yes	—
`data`	`string`	Yes	—

Scrape

extract

scrape.extract Extract selected HTML elements: https://developers.cloudflare.com/browser-run/quick-actions/scrape-endpoint/. Risk: read

await corsair.cloudflarebrowserrendering.api.scrape.extract({
	accountId: 'acct-123',
	body: {
		url: 'https://example.com',
		elements: [{ selector: 'h1' }],
	},
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string,
  elements: {
    selector: string
  }[]
}

Output: object[]

Output full type

{
  results: {
    attributes: {
      name: string,
      value: string
    }[],
    height: number,
    html: string,
    left: number,
    text: string,
    top: number,
    width: number
  }[],
  selector: string
}[]

Screenshot

capture

screenshot.capture Capture a screenshot as JSON-safe base64 data: https://developers.cloudflare.com/browser-run/quick-actions/screenshot-endpoint/. Risk: destructive

await corsair.cloudflarebrowserrendering.api.screenshot.capture({ accountId: 'acct-123', browser: 'kitesurf', cacheTTL: 30, body: { url: 'https://example.com', screenshotOptions: { fullPage: true } } });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`browser`	`kitesurf`	No	—
`cacheTTL`	`number`	No	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string,
  screenshotOptions?: {
    captureBeyondViewport?: boolean,
    clip?: {
      height: number,
      width: number,
      x: number,
      y: number,
      scale?: number
    },
    fromSurface?: boolean,
    fullPage?: boolean,
    omitBackground?: boolean,
    optimizeForSpeed?: boolean,
    quality?: number,
    type?: png | jpeg | webp
  },
  scrollPage?: boolean,
  selector?: string
}

Output

Name	Type	Required	Description
`contentType`	`string`	Yes	—
`byteLength`	`number`	Yes	—
`data`	`string`	Yes	—

Sessions

get

sessions.get Get details for a Browser Rendering session: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/session/methods/get/. Risk: read

await corsair.cloudflarebrowserrendering.api.sessions.get({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—

Output

Name	Type	Required	Description
`sessionId`	`string`	Yes	—
`closeReason`	`number`	No	—
`closeReasonText`	`string`	No	—
`connectionEndTime`	`number`	No	—
`connectionId`	`string`	No	—
`connectionStartTime`	`number`	No	—
`devtoolsFrontendUrl`	`string`	No	—
`endTime`	`number`	No	—
`lastUpdated`	`number`	No	—
`startTime`	`number`	No	—
`webSocketDebuggerUrl`	`string`	No	—

list

sessions.list List active Browser Rendering sessions: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/session/methods/list/. Risk: read

await corsair.cloudflarebrowserrendering.api.sessions.list({ accountId: 'acct-123', limit: 20, offset: 5 });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output: object[]

Output full type

{
  sessionId: string,
  closeReason?: number,
  closeReasonText?: string,
  connectionEndTime?: number,
  connectionId?: string,
  connectionStartTime?: number,
  devtoolsFrontendUrl?: string,
  endTime?: number,
  lastUpdated?: number,
  startTime?: number,
  webSocketDebuggerUrl?: string
}[]

Snapshot

capture

snapshot.capture Capture multiple page formats in one request: https://developers.cloudflare.com/browser-run/quick-actions/snapshot/. Risk: destructive

await corsair.cloudflarebrowserrendering.api.snapshot.capture({
	accountId: 'acct-123',
	body: {
		url: 'https://example.com',
		formats: ['content', 'screenshot'],
	},
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  actionTimeout?: number,
  addScriptTag?: {
    id?: string,
    content?: string,
    type?: string,
    url?: string
  }[],
  addStyleTag?: {
    content?: string,
    url?: string
  }[],
  allowRequestPattern?: string[],
  allowResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  authenticate?: {
    password: string,
    username: string
  },
  bestAttempt?: boolean,
  cookies?: {
    name: string,
    value: string,
    domain?: string,
    expires?: number,
    httpOnly?: boolean,
    partitionKey?: string,
    path?: string,
    priority?: Low | Medium | High,
    sameParty?: boolean,
    sameSite?: Strict | Lax | None,
    secure?: boolean,
    sourcePort?: number,
    sourceScheme?: Unset | NonSecure | Secure,
    url?: string
  }[],
  emulateMediaType?: string,
  gotoOptions?: {
    referer?: string,
    referrerPolicy?: string,
    timeout?: number,
    waitUntil?: load | domcontentloaded | networkidle0 | networkidle2 | (load | domcontentloaded | networkidle0 | networkidle2)[]
  },
  rejectRequestPattern?: string[],
  rejectResourceTypes?: (document | stylesheet | image | media | font | script | texttrack | xhr | fetch | prefetch | eventsource | websocket | manifest | signedexchange | ping | cspviolationreport | preflight | other)[],
  setExtraHTTPHeaders?: Record<string, string>,
  setJavaScriptEnabled?: boolean,
  viewport?: {
    height: number,
    width: number,
    deviceScaleFactor?: number,
    hasTouch?: boolean,
    isLandscape?: boolean,
    isMobile?: boolean
  },
  waitForSelector?: {
    selector: string,
    hidden?: true,
    timeout?: number,
    visible?: true
  },
  waitForTimeout?: number,
  html?: string,
  url?: string,
  userAgent?: string,
  formats?: (content | screenshot | markdown | accessibilityTree)[],
  screenshotOptions?: {
    captureBeyondViewport?: boolean,
    clip?: {
      height: number,
      width: number,
      x: number,
      y: number,
      scale?: number
    },
    fromSurface?: boolean,
    fullPage?: boolean,
    omitBackground?: boolean,
    optimizeForSpeed?: boolean,
    quality?: number,
    type?: png | jpeg | webp
  }
}

Output

Name	Type	Required	Description
`accessibilityTree`	`object`	No	—
`content`	`string`	No	—
`markdown`	`string`	No	—
`screenshot`	`string`	No	—

accessibilityTree full type

{
  role: string
}

Targets

activate

targets.activate Activate a browser target: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/activate/. Risk: write

await corsair.cloudflarebrowserrendering.api.targets.activate({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', targetId: 'target-123' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—
`targetId`	`string`	Yes	—

Output

Name	Type	Required	Description
`message`	`string`	Yes	—

close

targets.close Close a browser target: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/close/. Risk: write

await corsair.cloudflarebrowserrendering.api.targets.close({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', targetId: 'target-123' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—
`targetId`	`string`	Yes	—

Output

Name	Type	Required	Description
`message`	`string`	Yes	—

create

targets.create Open a browser tab: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/create/. Risk: write

await corsair.cloudflarebrowserrendering.api.targets.create({
	accountId: 'acct-123',
	sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
	liveViewUrlExpiresInMs: 600000,
	url: 'https://example.com',
});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—
`liveViewUrlExpiresInMs`	`number`	No	—
`url`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`type`	`string`	Yes	—
`url`	`string`	Yes	—
`description`	`string`	No	—
`devtoolsFrontendUrl`	`string`	No	—
`title`	`string`	No	—
`webSocketDebuggerUrl`	`string`	No	—

get

targets.get Get a debuggable target by ID: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/get/. Risk: read

await corsair.cloudflarebrowserrendering.api.targets.get({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', targetId: 'target-123' });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—
`targetId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`type`	`string`	Yes	—
`url`	`string`	Yes	—
`description`	`string`	No	—
`devtoolsFrontendUrl`	`string`	No	—
`title`	`string`	No	—
`webSocketDebuggerUrl`	`string`	No	—

list

targets.list List debuggable browser targets: https://developers.cloudflare.com/api/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/list/. Risk: read

await corsair.cloudflarebrowserrendering.api.targets.list({ accountId: 'acct-123', sessionId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', liveViewUrlExpiresInMs: 60000 });

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	—
`sessionId`	`string`	Yes	—
`liveViewUrlExpiresInMs`	`number`	No	—

Output: object[]

Output full type

{
  id: string,
  type: string,
  url: string,
  description?: string,
  devtoolsFrontendUrl?: string,
  title?: string,
  webSocketDebuggerUrl?: string
}[]

Overview

Plugins

Cloudflare Browser Run API reference

Accessibility Tree

capture

Browser

close

create

liveView.create

protocol

version

Content

fetch

Crawl

cancel

get

start

Json

extract

Links

list

Markdown

convert

Pdf

render

Scrape

extract

Screenshot

capture

Sessions

get

list

Snapshot

capture

Targets

activate

close

create

get

list