openapi: 3.2.0
info:
  description: Welcome to Cloudflare's API documentation site.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: Cloudflare Brapi API
  version: 4.0.0
servers:
- description: Client API
  url: https://api.cloudflare.com/client/v4
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:
- name: brapi
paths:
  /accounts/{account_id}/browser-rendering/accessibilityTree:
    post:
      operationId: brapi-post_AccessibilityTree
      summary: Get accessibility tree page
      description: Returns the page's accessibility tree. Use `interestingOnly` to only return semantically meaningful nodes; use `root` to scope the tree to a CSS-selector-anchored subtree. Control page loading with `gotoOptions` and `waitFor*` options.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                emulateMediaType:
                  type: string
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                interestingOnly:
                  type: boolean
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                root:
                  type: string
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
      responses:
        '200':
          description: Returns the requested formats information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  meta:
                    type: object
                    properties:
                      finalUrl:
                        description: URL that served the response, after any redirects the browser followed.
                        type: string
                      headers:
                        description: Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted.
                        type: object
                        additionalProperties:
                          type: string
                      redirectChain:
                        description: HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read.
                        type: array
                        items:
                          properties:
                            headers:
                              description: Redirect response headers, including `location`.
                              type: object
                              additionalProperties:
                                type: string
                            status:
                              description: HTTP status of the redirect.
                              type: number
                            url:
                              description: URL that returned the redirect.
                              type: string
                          required:
                          - url
                          - status
                          - headers
                          type: object
                      status:
                        description: HTTP status returned by the origin.
                        type: number
                      title:
                        description: Page title.
                        type: string
                  result:
                    type: object
                    properties:
                      accessibilityTree:
                        allOf:
                        - $ref: '#/components/schemas/brapi_SerializedAXNode'
                        - type:
                          - object
                          - 'null'
                    required:
                    - accessibilityTree
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - result
                - meta
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: accessibility-tree
  /accounts/{account_id}/browser-rendering/content:
    post:
      operationId: brapi-post_Content
      summary: Get HTML content
      description: Fetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                emulateMediaType:
                  type: string
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
      responses:
        '200':
          description: Returns the page's content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  meta:
                    type: object
                    properties:
                      finalUrl:
                        description: URL that served the response, after any redirects the browser followed.
                        type: string
                      headers:
                        description: Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted.
                        type: object
                        additionalProperties:
                          type: string
                      redirectChain:
                        description: HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read.
                        type: array
                        items:
                          properties:
                            headers:
                              description: Redirect response headers, including `location`.
                              type: object
                              additionalProperties:
                                type: string
                            status:
                              description: HTTP status of the redirect.
                              type: number
                            url:
                              description: URL that returned the redirect.
                              type: string
                          required:
                          - url
                          - status
                          - headers
                          type: object
                      status:
                        description: HTTP status returned by the origin.
                        type: number
                      title:
                        description: Page title.
                        type: string
                  result:
                    description: HTML content.
                    type: string
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - meta
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: content
  /accounts/{account_id}/browser-rendering/crawl:
    post:
      operationId: brapi-post_Crawl
      summary: Crawl websites
      description: Starts a crawl job for the provided URL and its children. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  url: https://www.example.com/
            schema:
              anyOf:
              - additionalProperties: false
                properties:
                  actionTimeout:
                    description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                    type: number
                    maximum: 120000
                  addScriptTag:
                    description: Adds a script element into the page with the desired URL or content.
                    type: array
                    items:
                      additionalProperties: false
                      properties:
                        content:
                          type: string
                        id:
                          type: string
                        type:
                          type: string
                        url:
                          type: string
                          format: uri
                      type: object
                  addStyleTag:
                    description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                    type: array
                    items:
                      properties:
                        content:
                          type: string
                        url:
                          type: string
                          format: uri
                      type: object
                  allowRequestPattern:
                    description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                    type: array
                    items:
                      type: string
                  allowResourceTypes:
                    description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                    type: array
                    items:
                      anyOf:
                      - enum:
                        - document
                        type: string
                      - enum:
                        - stylesheet
                        type: string
                      - enum:
                        - image
                        type: string
                      - enum:
                        - media
                        type: string
                      - enum:
                        - font
                        type: string
                      - enum:
                        - script
                        type: string
                      - enum:
                        - texttrack
                        type: string
                      - enum:
                        - xhr
                        type: string
                      - enum:
                        - fetch
                        type: string
                      - enum:
                        - prefetch
                        type: string
                      - enum:
                        - eventsource
                        type: string
                      - enum:
                        - websocket
                        type: string
                      - enum:
                        - manifest
                        type: string
                      - enum:
                        - signedexchange
                        type: string
                      - enum:
                        - ping
                        type: string
                      - enum:
                        - cspviolationreport
                        type: string
                      - enum:
                        - preflight
                        type: string
                      - enum:
                        - other
                        type: string
                  authenticate:
                    description: Provide credentials for HTTP authentication.
                    type: object
                    properties:
                      password:
                        type: string
                        minLength: 1
                        x-sensitive: true
                      username:
                        type: string
                        minLength: 1
                    required:
                    - username
                    - password
                  bestAttempt:
                    description: Attempt to proceed when 'awaited' events fail or timeout.
                    type: boolean
                  browser:
                    description: Rendering backend for this crawl. Set to `kitesurf` to render pages with Kitesurf (beta). Only valid when `render` is `true`.
                    type: string
                    enum:
                    - kitesurf
                  contentUse:
                    description: 'Intended content use level to respect the `use` Content-Signal directive in robots.txt. Levels (least to most permissive): ''reference'', ''full''. A URL is disallowed when the publisher''s declared `use` level is lower than this intent. Learn more: https://contentsignals.org/. Default: ''full''.'
                    default: full
                    anyOf:
                    - enum:
                      - reference
                      type: string
                    - enum:
                      - full
                      type: string
                  cookies:
                    description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                    type: array
                    items:
                      properties:
                        domain:
                          type: string
                        expires:
                          type: number
                        httpOnly:
                          type: boolean
                        name:
                          description: Cookie name.
                          type: string
                        partitionKey:
                          type: string
                        path:
                          type: string
                        priority:
                          anyOf:
                          - enum:
                            - Low
                            type: string
                          - enum:
                            - Medium
                            type: string
                          - enum:
                            - High
                            type: string
                        sameParty:
                          type: boolean
                        sameSite:
                          anyOf:
                          - enum:
                            - Strict
                            type: string
                          - enum:
                            - Lax
                            type: string
                          - enum:
                            - None
                            type: string
                        secure:
                          type: boolean
                        sourcePort:
                          type: number
                        sourceScheme:
                          anyOf:
                          - enum:
                            - Unset
                            type: string
                          - enum:
                            - NonSecure
                            type: string
                          - enum:
                            - Secure
                            type: string
                        url:
                          type: string
                        value:
                          type: string
                      required:
                      - name
                      - value
                      type: object
                  crawlPurposes:
                    description: 'List of crawl purposes to respect Content-Signal directives in robots.txt. Allowed values: ''search'', ''ai-input'', ''ai-train''. Learn more: https://contentsignals.org/. Default: [''search'', ''ai-input'', ''ai-train''].'
                    type: array
                    items:
                      anyOf:
                      - enum:
                        - search
                        type: string
                      - enum:
                        - ai-input
                        type: string
                      - enum:
                        - ai-train
                        type: string
                    default:
                    - search
                    - ai-input
                    - ai-train
                    maxItems: 3
                    minItems: 1
                  depth:
                    description: Maximum number of levels deep the crawler will traverse from the starting URL.
                    type: number
                    default: 100000
                    maximum: 100000
                    minimum: 1
                  emulateMediaType:
                    type: string
                  formats:
                    description: Formats to return. Default is `html`.
                    type: array
                    items:
                      anyOf:
                      - enum:
                        - html
                        type: string
                      - enum:
                        - markdown
                        type: string
                      - enum:
                        - json
                        type: string
                    default:
                    - html
                  gotoOptions:
                    description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                    type: object
                    default: {}
                    properties:
                      referer:
                        type: string
                      referrerPolicy:
                        type: string
                      timeout:
                        type: number
                        default: 30000
                        maximum: 60000
                      waitUntil:
                        default: domcontentloaded
                        anyOf:
                        - enum:
                          - load
                          type: string
                        - enum:
                          - domcontentloaded
                          type: string
                        - enum:
                          - networkidle0
                          type: string
                        - enum:
                          - networkidle2
                          type: string
                        - items:
                            anyOf:
                            - enum:
                              - load
                              type: string
                            - enum:
                              - domcontentloaded
                              type: string
                            - enum:
                              - networkidle0
                              type: string
                            - enum:
                              - networkidle2
                              type: string
                          type: array
                  jsonOptions:
                    description: Options for JSON extraction.
                    type: object
                    additionalProperties: false
                    properties:
                      custom_ai:
                        description: Optional list of custom AI models to use for the request. The models will be tried in the order provided, and in case a model returns an error, the next one will be used as fallback.
                        type: array
                        items:
                          properties:
                            authorization:
                              description: 'Authorization token for the AI model: `Bearer <token>`. Not needed for workers-ai models.'
                              type: string
                            model:
                              description: AI model to use for the request. Must be formed as `<provider>/<model_name>`, e.g. `workers-ai/@cf/meta/llama-3.3-70b-instruct-fp8-fast`.
                              type: string
                          required:
                          - model
                          type: object
                      prompt:
                        type: string
                      response_format:
                        type: object
                        properties:
                          json_schema:
                            description: 'Schema for the response format. More information here: https://developers.cloudflare.com/workers-ai/json-mode/'
                            type:
                            - object
                            - 'null'
                            additionalProperties: true
                          type:
                            type: string
                        required:
                        - type
                  limit:
                    description: Maximum number of URLs to crawl.
                    type: number
                    default: 10
                    maximum: 100000
                    minimum: 1
                  maxAge:
                    description: Maximum age of a resource that can be returned from cache in seconds. Default is 1 day.
                    type: number
                    default: 86400
                    maximum: 604800
                    minimum: 0
                  modifiedSince:
                    description: 'Unix timestamp (seconds since epoch) indicating to only crawl pages that were modified since this time. For sitemap URLs with a lastmod field, this is compared directly. For other URLs, the crawler will use If-Modified-Since header when fetching. URLs without modification information (no lastmod in sitemap and no Last-Modified header support) will be crawled. Note: This works in conjunction with maxAge - both filters must pass for a cached resource to be used. Must be within the last year and not in the future.'
                    type: integer
                    exclusiveMinimum: 0
                  options:
                    description: Additional options for the crawler.
                    type: object
                    default:
                      includeExternalLinks: false
                      includeSubdomains: false
                    properties:
                      excludePatterns:
                        description: 'Exclude links matching the provided wildcard patterns in the crawl job. Example: ''https://example.com/privacy/**''.'
                        type: array
                        items:
                          maxLength: 500
                          minLength: 1
                          type: string
                        maxItems: 100
                      includeExternalLinks:
                        description: Include external links in the crawl job. If set to true, includeSubdomains is ignored.
                        type: boolean
                        default: false
                      includePatterns:
                        description: 'Include only links matching the provided wildcard patterns in the crawl job. Include patterns are evaluated before exclude patterns. URLs that match any of the specified include patterns will be included in the crawl job. Example: ''https://example.com/blog/**''.'
                        type: array
                        items:
                          maxLength: 500
                          minLength: 1
                          type: string
                        maxItems: 100
                      includeSubdomains:
                        description: Include links to subdomains in the crawl job. This option is ignored if includeExternalLinks is true.
                        type: boolean
                        default: false
                  rejectRequestPattern:
                    description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                    type: array
                    items:
                      type: string
                  rejectResourceTypes:
                    description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                    type: array
                    items:
                      anyOf:
                      - enum:
                        - document
                        type: string
                      - enum:
                        - stylesheet
                        type: string
                      - enum:
                        - image
                        type: string
                      - enum:
                        - media
                        type: string
                      - enum:
                        - font
                        type: string
                      - enum:
                        - script
                        type: string
                      - enum:
                        - texttrack
                        type: string
                      - enum:
                        - xhr
                        type: string
                      - enum:
                        - fetch
                        type: string
                      - enum:
                        - prefetch
                        type: string
                      - enum:
                        - eventsource
                        type: string
                      - enum:
                        - websocket
                        type: string
                      - enum:
                        - manifest
                        type: string
                      - enum:
                        - signedexchange
                        type: string
                      - enum:
                        - ping
                        type: string
                      - enum:
                        - cspviolationreport
                        type: string
                      - enum:
                        - preflight
                        type: string
                      - enum:
                        - other
                        type: string
                  render:
                    description: Whether to render the page or fetch static content. True by default.
                    type: boolean
                    default: true
                    enum:
                    - true
                  setExtraHTTPHeaders:
                    type: object
                    additionalProperties:
                      type: string
                  setJavaScriptEnabled:
                    type: boolean
                  source:
                    description: Source of links to crawl. 'sitemaps' - only crawl URLs from sitemaps, 'links' - only crawl URLs scraped from pages, 'all' - crawl both sitemap and scraped links (default).
                    default: all
                    anyOf:
                    - enum:
                      - sitemaps
                      type: string
                    - enum:
                      - links
                      type: string
                    - enum:
                      - all
                      type: string
                  url:
                    description: URL to navigate to, eg. `https://example.com`.
                    type: string
                    format: uri
                  viewport:
                    description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                    type: object
                    default:
                      height: 1080
                      width: 1920
                    properties:
                      deviceScaleFactor:
                        type: number
                      hasTouch:
                        type: boolean
                      height:
                        type: number
                      isLandscape:
                        type: boolean
                      isMobile:
                        type: boolean
                      width:
                        type: number
                    required:
                    - width
                    - height
                  waitForSelector:
                    description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                    type: object
                    properties:
                      hidden:
                        type: boolean
                        enum:
                        - true
                      selector:
                        type: string
                      timeout:
                        type: number
                        maximum: 120000
                      visible:
                        type: boolean
                        enum:
                        - true
                    required:
                    - selector
                  waitForTimeout:
                    description: Waits for a specified timeout before continuing.
                    type: number
                    maximum: 120000
                required:
                - url
                type: object
              - additionalProperties: false
                properties:
                  contentUse:
                    description: 'Intended content use level to respect the `use` Content-Signal directive in robots.txt. Levels (least to most permissive): ''reference'', ''full''. A URL is disallowed when the publisher''s declared `use` level is lower than this intent. Learn more: https://contentsignals.org/. Default: ''full''.'
                    default: full
                    anyOf:
                    - enum:
                      - reference
                      type: string
                    - enum:
                      - full
                      type: string
                  crawlPurposes:
                    description: 'List of crawl purposes to respect Content-Signal directives in robots.txt. Allowed values: ''search'', ''ai-input'', ''ai-train''. Learn more: https://contentsignals.org/. Default: [''search'', ''ai-input'', ''ai-train''].'
                    type: array
                    items:
                      anyOf:
                      - enum:
                        - search
                        type: string
                      - enum:
                        - ai-input
                        type: string
                      - enum:
                        - ai-train
                        type: string
                    default:
                    - search
                    - ai-input
                    - ai-train
                    maxItems: 3
                    minItems: 1
                  depth:
                    description: Maximum number of levels deep the crawler will traverse from the starting URL.
                    type: number
                    default: 100000
                    maximum: 100000
                    minimum: 1
                  formats:
                    description: Formats to return. Default is `html`.
                    type: array
                    items:
                      anyOf:
                      - enum:
                        - html
                        type: string
                      - enum:
                        - markdown
                        type: string
                      - enum:
                        - json
                        type: string
                    default:
                    - html
                  jsonOptions:
                    description: Options for JSON extraction.
                    type: object
                    additionalProperties: false
                    properties:
                      custom_ai:
                        description: Optional list of custom AI models to use for the request. The models will be tried in the order provided, and in case a model returns an error, the next one will be used as fallback.
                        type: array
                        items:
                          properties:
                            authorization:
                              description: 'Authorization token for the AI model: `Bearer <token>`. Not needed for workers-ai models.'
                              type: string
                            model:
                              description: AI model to use for the request. Must be formed as `<provider>/<model_name>`, e.g. `workers-ai/@cf/meta/llama-3.3-70b-instruct-fp8-fast`.
                              type: string
                          required:
                          - model
                          type: object
                      prompt:
                        type: string
                      response_format:
                        type: object
                        properties:
                          json_schema:
                            description: 'Schema for the response format. More information here: https://developers.cloudflare.com/workers-ai/json-mode/'
                            type:
                            - object
                            - 'null'
                            additionalProperties: true
                          type:
                            type: string
                        required:
                        - type
                  limit:
                    description: Maximum number of URLs to crawl.
                    type: number
                    default: 10
                    maximum: 100000
                    minimum: 1
                  maxAge:
                    description: Maximum age of a resource that can be returned from cache in seconds. Default is 1 day.
                    type: number
                    default: 86400
                    maximum: 604800
                    minimum: 0
                  modifiedSince:
                    description: 'Unix timestamp (seconds since epoch) indicating to only crawl pages that were modified since this time. For sitemap URLs with a lastmod field, this is compared directly. For other URLs, the crawler will use If-Modified-Since header when fetching. URLs without modification information (no lastmod in sitemap and no Last-Modified header support) will be crawled. Note: This works in conjunction with maxAge - both filters must pass for a cached resource to be used. Must be within the last year and not in the future.'
                    type: integer
                    exclusiveMinimum: 0
                  options:
                    description: Additional options for the crawler.
                    type: object
                    default:
                      includeExternalLinks: false
                      includeSubdomains: false
                    properties:
                      excludePatterns:
                        description: 'Exclude links matching the provided wildcard patterns in the crawl job. Example: ''https://example.com/privacy/**''.'
                        type: array
                        items:
                          maxLength: 500
                          minLength: 1
                          type: string
                        maxItems: 100
                      includeExternalLinks:
                        description: Include external links in the crawl job. If set to true, includeSubdomains is ignored.
                        type: boolean
                        default: false
                      includePatterns:
                        description: 'Include only links matching the provided wildcard patterns in the crawl job. Include patterns are evaluated before exclude patterns. URLs that match any of the specified include patterns will be included in the crawl job. Example: ''https://example.com/blog/**''.'
                        type: array
                        items:
                          maxLength: 500
                          minLength: 1
                          type: string
                        maxItems: 100
                      includeSubdomains:
                        description: Include links to subdomains in the crawl job. This option is ignored if includeExternalLinks is true.
                        type: boolean
                        default: false
                  render:
                    description: Whether to render the page or fetch static content. True by default.
                    type: boolean
                    enum:
                    - false
                  source:
                    description: Source of links to crawl. 'sitemaps' - only crawl URLs from sitemaps, 'links' - only crawl URLs scraped from pages, 'all' - crawl both sitemap and scraped links (default).
                    default: all
                    anyOf:
                    - enum:
                      - sitemaps
                      type: string
                    - enum:
                      - links
                      type: string
                    - enum:
                      - all
                      type: string
                  url:
                    description: URL to navigate to, eg. `https://example.com`.
                    type: string
                    format: uri
                required:
                - url
                - render
                type: object
      responses:
        '200':
          description: Returns the ID for the started crawl job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  result:
                    description: Crawl job ID.
                    type: string
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - result
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.crawl
      x-fern-sdk-method-name: create
  /accounts/{account_id}/browser-rendering/crawl/{job_id}:
    delete:
      operationId: brapi-delete_CancelCrawl
      summary: Cancel a crawl job
      description: Cancels an ongoing crawl job by setting its status to cancelled and stopping all queued URLs.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: job_id
        in: path
        description: The ID of the crawl job to cancel.
        required: true
        schema:
          description: The ID of the crawl job to cancel.
          type: string
      responses:
        '200':
          description: Crawl job cancelled successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  result:
                    type: object
                    properties:
                      job_id:
                        description: The ID of the cancelled job.
                        type: string
                      message:
                        description: Cancellation confirmation message.
                        type: string
                    required:
                    - message
                    - job_id
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - result
        '400':
          description: Job is already in final status and cannot be cancelled.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '404':
          description: Crawl job not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.crawl
      x-fern-sdk-method-name: delete
    get:
      operationId: brapi-get_CrawlResult
      summary: Get crawl result
      description: Returns the result of a crawl job.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: job_id
        in: path
        description: Crawl job ID.
        required: true
        schema:
          description: Crawl job ID.
          type: string
          minLength: 1
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: status
        in: query
        description: Filter by URL status.
        schema:
          description: Filter by URL status.
          type: string
          enum:
          - queued
          - errored
          - completed
          - disallowed
          - skipped
          - cancelled
      - name: cursor
        in: query
        description: Cursor for pagination.
        schema:
          description: Cursor for pagination.
          type: number
          default: 0
      - name: limit
        in: query
        description: Limit for pagination.
        schema:
          description: Limit for pagination.
          type: number
          default: 50
      responses:
        '200':
          description: Returns the result of a crawl job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  result:
                    type: object
                    additionalProperties: false
                    properties:
                      browserSecondsUsed:
                        description: Total seconds spent in browser so far.
                        type: number
                      cursor:
                        description: Cursor for pagination.
                        type: string
                      finished:
                        description: Total number of URLs that have been crawled so far.
                        type: number
                      id:
                        description: Crawl job ID.
                        type: string
                      records:
                        description: List of crawl job records.
                        type: array
                        items:
                          additionalProperties: false
                          properties:
                            html:
                              description: HTML content of the crawled URL.
                              type: string
                            json:
                              description: JSON of the content of the crawled URL.
                              type: object
                              additionalProperties:
                                type:
                                - object
                                - 'null'
                            markdown:
                              description: Markdown of the content of the crawled URL.
                              type: string
                            metadata:
                              description: Absent for urls that never reached a fetch.
                              type: object
                              properties:
                                status:
                                  description: HTTP status code of the crawled page.
                                  type: number
                                title:
                                  description: Title of the crawled page.
                                  type: string
                                url:
                                  description: Final URL of the crawled page.
                                  type: string
                              required:
                              - url
                              - status
                            status:
                              description: Current status of the crawled URL.
                              type: string
                              enum:
                              - queued
                              - errored
                              - completed
                              - disallowed
                              - skipped
                              - cancelled
                            url:
                              description: Crawled URL.
                              type: string
                          required:
                          - url
                          - status
                          type: object
                      skipped:
                        description: 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.
                        type: number
                      status:
                        description: Current crawl job status.
                        type: string
                      total:
                        description: Total current number of URLs in the crawl job.
                        type: number
                    required:
                    - id
                    - status
                    - browserSecondsUsed
                    - total
                    - finished
                    - skipped
                    - records
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - result
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.crawl
      x-fern-sdk-method-name: get
  /accounts/{account_id}/browser-rendering/devtools/browser:
    post:
      operationId: brapi-post_DevtoolsAcquire
      summary: Get a browser session ID
      description: Acquires a browser and returns its session ID and websocket URL. Optionally accepts a JSON body with session guardrails to restrict outbound HTTP/S traffic.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: keep_alive
        in: query
        description: Keep-alive time in milliseconds.
        schema:
          description: Keep-alive time in milliseconds.
          type: number
          default: 60000
          maximum: 1200000
          minimum: 10000
      - name: lab
        in: query
        description: Use experimental browser.
        schema:
          description: Use experimental browser.
          type: boolean
          default: false
      - name: targets
        in: query
        description: Include browser targets in response.
        schema:
          description: Include browser targets in response.
          type: boolean
          default: false
      - name: liveViewUrlExpiresInMs
        in: query
        description: How long the live view URL remains valid, in milliseconds (max 60 minutes). Only used when targets is true.
        schema:
          description: How long the live view URL remains valid, in milliseconds (max 60 minutes). Only used when targets is true.
          type: number
          default: 300000
          maximum: 3600000
          minimum: 60000
      - name: recording
        in: query
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                guardrails:
                  type: object
                  additionalProperties: false
                  properties:
                    allowedDomainSets:
                      description: 'Max 4 entries: curated preset names (common-cdns) and/or https URLs of newline-separated hostname lists.'
                      type: array
                      items:
                        type: string
                      maxItems: 4
                    allowedDomains:
                      description: Hostname patterns, max 50. Supports exact hosts (example.com) or a single * wildcard anywhere. Prefer *.example.com (subdomain wildcard) over *example.com (prefix wildcard) to avoid matching overbroad lookalikes like evilexample.com.
                      type: array
                      items:
                        type: string
                      maxItems: 50
              additionalProperties: false
      responses:
        '200':
          description: Returns a session ID ready to be connected to.
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionId:
                    description: Browser session ID.
                    type: string
                  webSocketDebuggerUrl:
                    description: WebSocket URL for the session.
                    type: string
                required:
                - sessionId
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  status:
                    description: Response status.
                    type: boolean
                required:
                - status
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser
      x-fern-sdk-method-name: create
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}:
    delete:
      operationId: brapi-delete_DevtoolsBrowserDelete
      summary: Close browser session
      description: Closes an existing browser session.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Browser session ID to close.
        required: true
        schema:
          description: Browser session ID to close.
          type: string
          format: uuid
      responses:
        '200':
          description: Browser session closing or already closed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - closing
                    - closed
                required:
                - status
        '404':
          description: Browser session not found.
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser
      x-fern-sdk-method-name: delete
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json:
    get:
      operationId: brapi-get_DevtoolsJson
      summary: List targets
      description: Returns a list of all debuggable targets including tabs, pages, service workers, and other browser contexts.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Browser session ID.
        required: true
        schema:
          description: Browser session ID.
          type: string
          format: uuid
      - name: liveViewUrlExpiresInMs
        in: query
        description: How long the live view URLs remain valid, in milliseconds (max 60 minutes)
        schema:
          description: How long the live view URLs remain valid, in milliseconds (max 60 minutes)
          type: number
          default: 300000
          maximum: 3600000
          minimum: 60000
      responses:
        '200':
          description: List of targets.
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    description:
                      description: Target description.
                      type: string
                    devtoolsFrontendUrl:
                      description: DevTools frontend URL.
                      type: string
                    id:
                      description: Target ID.
                      type: string
                    title:
                      description: Title of the target.
                      type: string
                    type:
                      description: Target type (page, background_page, worker, etc.).
                      type: string
                    url:
                      description: URL of the target.
                      type: string
                    webSocketDebuggerUrl:
                      description: WebSocket URL for debugging this target.
                      type: string
                  required:
                  - id
                  - type
                  - url
                  type: object
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.json
      x-fern-sdk-method-name: get
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/activate/{target_id}:
    get:
      operationId: brapi-get_DevtoolsJsonActivate
      summary: Activate a browser target
      description: Activates (brings to front) a specific browser target by its ID.
      parameters:
      - name: session_id
        in: path
        description: Browser session ID.
        required: true
        schema:
          description: Browser session ID.
          type: string
          format: uuid
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: target_id
        in: path
        description: Target ID to activate.
        required: true
        schema:
          description: Target ID to activate.
          type: string
          pattern: ^[a-zA-Z0-9]+$
      responses:
        '200':
          description: Target activated successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    description: Target activated.
                    type: string
                required:
                - message
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '404':
          description: Target not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser.targets
      x-fern-sdk-method-name: activate
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/close/{target_id}:
    get:
      operationId: brapi-get_DevtoolsJsonClose
      summary: Close a browser target
      description: Closes a specific browser target (tab, page, etc.) by its ID. Returns 'Target is closing' on success or an error if the target is not found.
      parameters:
      - name: session_id
        in: path
        description: Browser session ID.
        required: true
        schema:
          description: Browser session ID.
          type: string
          format: uuid
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: target_id
        in: path
        description: Target ID to close.
        required: true
        schema:
          description: Target ID to close.
          type: string
          pattern: ^[a-zA-Z0-9]+$
      responses:
        '200':
          description: Target is closing.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    description: Target is closing.
                    type: string
                required:
                - message
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '404':
          description: Target not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser.targets
      x-fern-sdk-method-name: close
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list:
    get:
      operationId: brapi-get_DevtoolsJsonList
      summary: List targets
      description: Returns a list of all debuggable targets including tabs, pages, service workers, and other browser contexts.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Browser session ID.
        required: true
        schema:
          description: Browser session ID.
          type: string
          format: uuid
      - name: liveViewUrlExpiresInMs
        in: query
        description: How long the live view URLs remain valid, in milliseconds (max 60 minutes)
        schema:
          description: How long the live view URLs remain valid, in milliseconds (max 60 minutes)
          type: number
          default: 300000
          maximum: 3600000
          minimum: 60000
      responses:
        '200':
          description: List of targets.
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    description:
                      description: Target description.
                      type: string
                    devtoolsFrontendUrl:
                      description: DevTools frontend URL.
                      type: string
                    id:
                      description: Target ID.
                      type: string
                    title:
                      description: Title of the target.
                      type: string
                    type:
                      description: Target type (page, background_page, worker, etc.).
                      type: string
                    url:
                      description: URL of the target.
                      type: string
                    webSocketDebuggerUrl:
                      description: WebSocket URL for debugging this target.
                      type: string
                  required:
                  - id
                  - type
                  - url
                  type: object
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser.targets
      x-fern-sdk-method-name: list
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list/{target_id}:
    get:
      operationId: brapi-get_DevtoolsJsonTarget
      summary: Get a target by ID
      description: Returns the debuggable target with the given ID.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Browser session ID.
        required: true
        schema:
          description: Browser session ID.
          type: string
          format: uuid
      - name: target_id
        in: path
        description: Target ID.
        required: true
        schema:
          description: Target ID.
          type: string
          pattern: ^[a-zA-Z0-9]+$
      responses:
        '200':
          description: The target with the given ID.
          content:
            application/json:
              schema:
                type: object
                properties:
                  description:
                    description: Target description.
                    type: string
                  devtoolsFrontendUrl:
                    description: DevTools frontend URL.
                    type: string
                  id:
                    description: Target ID.
                    type: string
                  title:
                    description: Title of the target.
                    type: string
                  type:
                    description: Target type (page, background_page, worker, etc.).
                    type: string
                  url:
                    description: URL of the target.
                    type: string
                  webSocketDebuggerUrl:
                    description: WebSocket URL for debugging this target.
                    type: string
                required:
                - id
                - type
                - url
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '404':
          description: Target not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser.targets
      x-fern-sdk-method-name: get
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/new:
    put:
      operationId: brapi-put_DevtoolsJsonNew
      summary: Open a new browser tab
      description: Opens a new tab in the browser. Optionally specify a URL to navigate to.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Browser session ID.
        required: true
        schema:
          description: Browser session ID.
          type: string
          format: uuid
      - name: url
        in: query
        schema:
          type: string
          format: uri
      - name: liveViewUrlExpiresInMs
        in: query
        description: How long the live view URL remains valid, in milliseconds (max 60 minutes)
        schema:
          description: How long the live view URL remains valid, in milliseconds (max 60 minutes)
          type: number
          default: 300000
          maximum: 3600000
          minimum: 60000
      responses:
        '200':
          description: Information about the newly created tab.
          content:
            application/json:
              schema:
                type: object
                properties:
                  description:
                    description: Target description.
                    type: string
                  devtoolsFrontendUrl:
                    description: DevTools frontend URL.
                    type: string
                  id:
                    description: Target ID.
                    type: string
                  title:
                    description: Title of the target.
                    type: string
                  type:
                    description: Target type (page, background_page, worker, etc.).
                    type: string
                  url:
                    description: URL of the target.
                    type: string
                  webSocketDebuggerUrl:
                    description: WebSocket URL for debugging this target.
                    type: string
                required:
                - id
                - type
                - url
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser.targets
      x-fern-sdk-method-name: create
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/protocol:
    get:
      operationId: brapi-get_DevtoolsJsonProtocol
      summary: Get Chrome DevTools Protocol schema
      description: Returns the complete Chrome DevTools Protocol schema including all domains, commands, events, and types. This schema describes the entire CDP API surface.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Browser session ID.
        required: true
        schema:
          description: Browser session ID.
          type: string
          format: uuid
      responses:
        '200':
          description: Chrome DevTools Protocol schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  domains:
                    description: List of protocol domains.
                    type: array
                    items:
                      properties:
                        commands:
                          description: Available commands.
                          type: array
                          items:
                            additionalProperties:
                              type:
                              - object
                              - 'null'
                            type: object
                        dependencies:
                          description: Domain dependencies.
                          type: array
                          items:
                            type: string
                        domain:
                          description: Domain name.
                          type: string
                        events:
                          description: Available events.
                          type: array
                          items:
                            additionalProperties:
                              type:
                              - object
                              - 'null'
                            type: object
                        experimental:
                          description: Whether this domain is experimental.
                          type: boolean
                        types:
                          description: Type definitions.
                          type: array
                          items:
                            additionalProperties:
                              type:
                              - object
                              - 'null'
                            type: object
                      required:
                      - domain
                      type: object
                  version:
                    description: Protocol version.
                    type: object
                    properties:
                      major:
                        description: Major version.
                        type: string
                      minor:
                        description: Minor version.
                        type: string
                    required:
                    - major
                    - minor
                required:
                - domains
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser
      x-fern-sdk-method-name: protocol
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/version:
    get:
      operationId: brapi-get_DevtoolsJsonVersion
      summary: Get browser version metadata
      description: Get browser version metadata.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Browser session ID.
        required: true
        schema:
          description: Browser session ID.
          type: string
          format: uuid
      responses:
        '200':
          description: Browser version information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Browser:
                    description: Browser name and version.
                    type: string
                  Protocol-Version:
                    description: Chrome DevTools Protocol version.
                    type: string
                  User-Agent:
                    description: User agent string.
                    type: string
                  V8-Version:
                    description: V8 JavaScript engine version.
                    type: string
                  WebKit-Version:
                    description: WebKit version.
                    type: string
                  webSocketDebuggerUrl:
                    description: WebSocket URL for debugging the browser.
                    type: string
                required:
                - Browser
                - Protocol-Version
                - User-Agent
                - V8-Version
                - WebKit-Version
                - webSocketDebuggerUrl
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser
      x-fern-sdk-method-name: version
  /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/live_view:
    post:
      operationId: brapi-post_DevtoolsLiveView
      summary: Mint live view URLs for a browser session
      description: 'Generates time-limited URLs to view a remote browser session. Set `guardrails: { mode: ''readonly'' }` to create a view-only link.'
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Browser session ID
        required: true
        schema:
          description: Browser session ID
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                expiresInMs:
                  description: 'How long the live view URLs remain valid, in milliseconds. Default: 5 minutes. Max: 60 minutes.'
                  type: number
                  default: 300000
                  maximum: 3600000
                  minimum: 60000
                guardrails:
                  description: 'Connection guardrails. Use `{ mode: ''readonly'' }` to generate a view-only link.'
                  type: object
                  additionalProperties: false
                  properties:
                    mode:
                      type: string
                      enum:
                      - readonly
                  required:
                  - mode
                mode:
                  description: 'UI mode: ''devtools'' (Chrome DevTools), ''tab'' (single tab view), ''full'' (multi-tab browser)'
                  type: string
                  default: devtools
                  enum:
                  - devtools
                  - tab
                  - full
                targetId:
                  description: Target ID (page) to connect to. If omitted, auto-resolves to the first active page.
                  type: string
                  pattern: ^[a-fA-F0-9]+$
      responses:
        '200':
          description: Live view URLs generated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  devtoolsFrontendUrl:
                    description: URL to open the live view in a browser
                    type: string
                    format: uri
                  id:
                    description: Target ID
                    type: string
                  options:
                    type: object
                    properties:
                      guardrails:
                        description: Connection guardrails applied to this link
                        type: object
                        additionalProperties: false
                        properties:
                          mode:
                            type: string
                            enum:
                            - readonly
                        required:
                        - mode
                      mode:
                        description: UI mode for the live view
                        type: string
                        enum:
                        - devtools
                        - tab
                        - full
                    required:
                    - mode
                  webSocketDebuggerUrl:
                    description: WebSocket URL for CDP connection
                    type: string
                    format: uri
                required:
                - webSocketDebuggerUrl
                - devtoolsFrontendUrl
                - id
                - options
        '400':
          description: Bad request - invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '404':
          description: Browser session or target not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.browser.live-view
      x-fern-sdk-method-name: create
  /accounts/{account_id}/browser-rendering/devtools/session:
    get:
      operationId: brapi-get_DevtoolsSessionList
      summary: List sessions
      description: List active browser sessions.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: limit
        in: query
        schema:
          type: number
          default: 200
          maximum: 200
          minimum: 1
      - name: offset
        in: query
        schema:
          type: number
          default: 0
          minimum: 0
      responses:
        '200':
          description: Returns the account's sessions.
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    closeReason:
                      description: Reason code for session closure.
                      type: number
                    closeReasonText:
                      description: Human-readable close reason.
                      type: string
                    connectionEndTime:
                      description: Connection end time.
                      type: number
                    connectionId:
                      description: Connection ID.
                      type: string
                    connectionStartTime:
                      description: Connection start time.
                      type: number
                    devtoolsFrontendUrl:
                      description: DevTools frontend URL.
                      type: string
                    endTime:
                      description: Session end time.
                      type: number
                    lastUpdated:
                      description: Last updated timestamp.
                      type: number
                    sessionId:
                      description: Session ID.
                      type: string
                      format: uuid
                    startTime:
                      description: Session start time.
                      type: number
                    webSocketDebuggerUrl:
                      description: WebSocket URL for debugging this target.
                      type: string
                  required:
                  - sessionId
                  type: object
        '400':
          description: Bad request.
        '500':
          description: Internal server error.
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.session
      x-fern-sdk-method-name: list
  /accounts/{account_id}/browser-rendering/devtools/session/{session_id}:
    get:
      operationId: brapi-get_DevtoolsSessionDetails
      summary: Get session details
      description: Get details for a specific browser session.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Session ID.
        required: true
        schema:
          description: Session ID.
          type: string
          format: uuid
      responses:
        '200':
          description: Returns the session details.
          content:
            application/json:
              schema:
                type:
                - object
                - 'null'
                properties:
                  closeReason:
                    description: Reason code for session closure.
                    type: number
                  closeReasonText:
                    description: Human-readable close reason.
                    type: string
                  connectionEndTime:
                    description: Connection end time.
                    type: number
                  connectionId:
                    description: Connection ID.
                    type: string
                  connectionStartTime:
                    description: Connection start time.
                    type: number
                  devtoolsFrontendUrl:
                    description: DevTools frontend URL.
                    type: string
                  endTime:
                    description: Session end time.
                    type: number
                  lastUpdated:
                    description: Last updated timestamp.
                    type: number
                  sessionId:
                    description: Session ID.
                    type: string
                    format: uuid
                  startTime:
                    description: Session start time.
                    type: number
                  webSocketDebuggerUrl:
                    description: WebSocket URL for debugging this target.
                    type: string
                required:
                - sessionId
        '404':
          description: Session not found.
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.devtools.session
      x-fern-sdk-method-name: get
  /accounts/{account_id}/browser-rendering/json:
    post:
      operationId: brapi-post_Json
      summary: Get json
      description: Gets json from a webpage from a provided URL or HTML. Pass `prompt` or `schema` in the body. Control page loading with `gotoOptions` and `waitFor*` options.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                custom_ai:
                  description: Optional list of custom AI models to use for the request. The models will be tried in the order provided, and in case a model returns an error, the next one will be used as fallback.
                  type: array
                  items:
                    properties:
                      authorization:
                        description: 'Authorization token for the AI model: `Bearer <token>`. Not needed for workers-ai models.'
                        type: string
                      model:
                        description: AI model to use for the request. Must be formed as `<provider>/<model_name>`, e.g. `workers-ai/@cf/meta/llama-3.3-70b-instruct-fp8-fast`.
                        type: string
                    required:
                    - model
                    type: object
                emulateMediaType:
                  type: string
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                prompt:
                  type: string
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                response_format:
                  type: object
                  properties:
                    json_schema:
                      description: 'Schema for the response format. More information here: https://developers.cloudflare.com/workers-ai/json-mode/'
                      type:
                      - object
                      - 'null'
                      additionalProperties: true
                    type:
                      type: string
                  required:
                  - type
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
      responses:
        '200':
          description: Returns the JSON based on a user prompt or JSON schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  meta:
                    type: object
                    properties:
                      finalUrl:
                        description: URL that served the response, after any redirects the browser followed.
                        type: string
                      headers:
                        description: Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted.
                        type: object
                        additionalProperties:
                          type: string
                      redirectChain:
                        description: HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read.
                        type: array
                        items:
                          properties:
                            headers:
                              description: Redirect response headers, including `location`.
                              type: object
                              additionalProperties:
                                type: string
                            status:
                              description: HTTP status of the redirect.
                              type: number
                            url:
                              description: URL that returned the redirect.
                              type: string
                          required:
                          - url
                          - status
                          - headers
                          type: object
                      status:
                        description: HTTP status returned by the origin.
                        type: number
                      title:
                        description: Page title.
                        type: string
                  result:
                    type: object
                    additionalProperties:
                      type:
                      - object
                      - 'null'
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - result
                - meta
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  rawAiResponse:
                    description: Raw AI response will be returned, if it couldn't be parsed into valid JSON.
                    type: string
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: json
  /accounts/{account_id}/browser-rendering/links:
    post:
      operationId: brapi-post_Links
      summary: Get Links
      description: Get links from a web page.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                emulateMediaType:
                  type: string
                excludeExternalLinks:
                  type: boolean
                  default: false
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                visibleLinksOnly:
                  type: boolean
                  default: false
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
      responses:
        '200':
          description: Returns the links.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  meta:
                    type: object
                    properties:
                      finalUrl:
                        description: URL that served the response, after any redirects the browser followed.
                        type: string
                      headers:
                        description: Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted.
                        type: object
                        additionalProperties:
                          type: string
                      redirectChain:
                        description: HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read.
                        type: array
                        items:
                          properties:
                            headers:
                              description: Redirect response headers, including `location`.
                              type: object
                              additionalProperties:
                                type: string
                            status:
                              description: HTTP status of the redirect.
                              type: number
                            url:
                              description: URL that returned the redirect.
                              type: string
                          required:
                          - url
                          - status
                          - headers
                          type: object
                      status:
                        description: HTTP status returned by the origin.
                        type: number
                      title:
                        description: Page title.
                        type: string
                  result:
                    type: array
                    items:
                      type: string
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - result
                - meta
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: links
  /accounts/{account_id}/browser-rendering/markdown:
    post:
      operationId: brapi-post_Markdown
      summary: Get markdown
      description: Gets markdown of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                emulateMediaType:
                  type: string
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
      responses:
        '200':
          description: Returns the page markdown.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  meta:
                    type: object
                    properties:
                      finalUrl:
                        description: URL that served the response, after any redirects the browser followed.
                        type: string
                      headers:
                        description: Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted.
                        type: object
                        additionalProperties:
                          type: string
                      redirectChain:
                        description: HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read.
                        type: array
                        items:
                          properties:
                            headers:
                              description: Redirect response headers, including `location`.
                              type: object
                              additionalProperties:
                                type: string
                            status:
                              description: HTTP status of the redirect.
                              type: number
                            url:
                              description: URL that returned the redirect.
                              type: string
                          required:
                          - url
                          - status
                          - headers
                          type: object
                      status:
                        description: HTTP status returned by the origin.
                        type: number
                      title:
                        description: Page title.
                        type: string
                  result:
                    description: Markdown content. Prefixed with YAML frontmatter (e.g. `title`) when the page provides that metadata.
                    type: string
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - meta
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: markdown
  /accounts/{account_id}/browser-rendering/pdf:
    post:
      operationId: brapi-post_Pdf
      summary: Get PDF
      description: Fetches rendered PDF from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                emulateMediaType:
                  type: string
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                pdfOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.pdfoptions).
                  type: object
                  default: {}
                  additionalProperties: false
                  properties:
                    displayHeaderFooter:
                      description: Whether to show the header and footer.
                      type: boolean
                      default: false
                    footerTemplate:
                      description: HTML template for the print footer.
                      type: string
                    format:
                      description: Paper format. Takes priority over width and height if set.
                      type: string
                      default: letter
                      enum:
                      - letter
                      - legal
                      - tabloid
                      - ledger
                      - a0
                      - a1
                      - a2
                      - a3
                      - a4
                      - a5
                      - a6
                    headerTemplate:
                      description: HTML template for the print header.
                      type: string
                    height:
                      description: Sets the height of paper. Can be a number or string with unit.
                      anyOf:
                      - type: string
                      - type: number
                    landscape:
                      description: Whether to print in landscape orientation.
                      type: boolean
                      default: false
                    margin:
                      description: Set the PDF margins. Useful when setting header and footer.
                      type: object
                      properties:
                        bottom:
                          anyOf:
                          - type: string
                          - type: number
                        left:
                          anyOf:
                          - type: string
                          - type: number
                        right:
                          anyOf:
                          - type: string
                          - type: number
                        top:
                          anyOf:
                          - type: string
                          - type: number
                    omitBackground:
                      description: Hides default white background and allows generating pdfs with transparency.
                      type: boolean
                      default: false
                    outline:
                      description: Generate document outline.
                      type: boolean
                      default: false
                    pageRanges:
                      description: Paper ranges to print, e.g. '1-5, 8, 11-13'.
                      type: string
                    preferCSSPageSize:
                      description: Give CSS @page size priority over other size declarations.
                      type: boolean
                      default: false
                    printBackground:
                      description: Set to true to print background graphics.
                      type: boolean
                      default: false
                    scale:
                      description: Scales the rendering of the web page. Amount must be between 0.1 and 2.
                      type: number
                      default: 1
                      maximum: 2
                      minimum: 0.1
                    tagged:
                      description: Generate tagged (accessible) PDF.
                      type: boolean
                      default: true
                    timeout:
                      description: Timeout in milliseconds.
                      type: number
                      default: 30000
                    width:
                      description: Sets the width of paper. Can be a number or string with unit.
                      anyOf:
                      - type: string
                      - type: number
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
      responses:
        '200':
          description: Returns the PDF.
          content:
            application/pdf:
              schema:
                description: PDF binary.
                type: string
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: pdf
  /accounts/{account_id}/browser-rendering/recording/{session_id}:
    get:
      operationId: brapi-get_Recording
      summary: Get recording data
      description: Returns the recording data for a given session as a dictionary of events per targetId.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Session ID.
        required: true
        schema:
          description: Session ID.
          type: string
          minLength: 1
      responses:
        '200':
          description: Returns the recording data as a dictionary of events per targetId.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  result:
                    type: object
                    additionalProperties: false
                    properties:
                      duration:
                        description: Recording duration in milliseconds.
                        type: number
                      events:
                        description: Recording events by target ID.
                        type: object
                        additionalProperties:
                          items:
                            additionalProperties:
                              type:
                              - object
                              - 'null'
                            type: object
                          type: array
                      sessionId:
                        description: Session ID.
                        type: string
                    required:
                    - sessionId
                    - events
                    - duration
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - result
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '404':
          description: Recording not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.recording
      x-fern-sdk-method-name: get
  /accounts/{account_id}/browser-rendering/recording/{session_id}/network:
    get:
      operationId: brapi-get_RecordingNetwork
      summary: Get network recording data
      description: Returns network recording events for the requested target ID. Use ?format=har for a HAR JSON document.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: session_id
        in: path
        description: Session ID.
        required: true
        schema:
          description: Session ID.
          type: string
          minLength: 1
      - name: format
        in: query
        description: Set to `har` to return a HAR JSON document.
        schema:
          description: Set to `har` to return a HAR JSON document.
          type: string
      - name: target
        in: query
        description: Target ID to include in the response.
        required: true
        schema:
          description: Target ID to include in the response.
          type: string
          minLength: 1
      responses:
        '200':
          description: Returns network recording events for the requested target ID, or HAR JSON when format=har.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type:
                  - object
                  - 'null'
        '404':
          description: Network recording not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      - Browser Rendering Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.recording.network
      x-fern-sdk-method-name: get
  /accounts/{account_id}/browser-rendering/scrape:
    post:
      operationId: brapi-post_Scrape
      summary: Scrape elements
      description: Get meta attributes like height, width, text and others of selected elements.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  elements:
                  - selector: h1
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                elements:
                  type: array
                  items:
                    properties:
                      selector:
                        type: string
                    required:
                    - selector
                    type: object
                  minItems: 1
                emulateMediaType:
                  type: string
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
              required:
              - elements
      responses:
        '200':
          description: Returns the scraped elements.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  meta:
                    type: object
                    properties:
                      finalUrl:
                        description: URL that served the response, after any redirects the browser followed.
                        type: string
                      headers:
                        description: Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted.
                        type: object
                        additionalProperties:
                          type: string
                      redirectChain:
                        description: HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read.
                        type: array
                        items:
                          properties:
                            headers:
                              description: Redirect response headers, including `location`.
                              type: object
                              additionalProperties:
                                type: string
                            status:
                              description: HTTP status of the redirect.
                              type: number
                            url:
                              description: URL that returned the redirect.
                              type: string
                          required:
                          - url
                          - status
                          - headers
                          type: object
                      status:
                        description: HTTP status returned by the origin.
                        type: number
                      title:
                        description: Page title.
                        type: string
                  result:
                    type: array
                    items:
                      properties:
                        results:
                          type: object
                          properties:
                            attributes:
                              type: array
                              items:
                                properties:
                                  name:
                                    description: Attribute name.
                                    type: string
                                  value:
                                    description: Attribute value.
                                    type: string
                                required:
                                - name
                                - value
                                type: object
                            height:
                              description: Element height.
                              type: number
                            html:
                              description: HTML content.
                              type: string
                            left:
                              description: Element left.
                              type: number
                            text:
                              description: Text content.
                              type: string
                            top:
                              description: Element top.
                              type: number
                            width:
                              description: Element width.
                              type: number
                          required:
                          - attributes
                          - height
                          - html
                          - left
                          - text
                          - top
                          - width
                        selector:
                          description: Selector.
                          type: string
                      required:
                      - results
                      - selector
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - result
                - meta
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: scrape
  /accounts/{account_id}/browser-rendering/screenshot:
    post:
      operationId: brapi-post_Screenshot
      summary: Get screenshot
      description: Takes a screenshot of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                emulateMediaType:
                  type: string
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                screenshotOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.screenshotoptions).
                  type: object
                  default: {}
                  additionalProperties: false
                  properties:
                    captureBeyondViewport:
                      type: boolean
                    clip:
                      type: object
                      properties:
                        height:
                          type: number
                        scale:
                          type: number
                        width:
                          type: number
                        x:
                          type: number
                        y:
                          type: number
                      required:
                      - x
                      - y
                      - width
                      - height
                    encoding:
                      default: binary
                      anyOf:
                      - enum:
                        - binary
                        type: string
                      - enum:
                        - base64
                        type: string
                    fromSurface:
                      type: boolean
                    fullPage:
                      type: boolean
                    omitBackground:
                      type: boolean
                    optimizeForSpeed:
                      type: boolean
                    quality:
                      type: number
                    type:
                      default: png
                      anyOf:
                      - enum:
                        - png
                        type: string
                      - enum:
                        - jpeg
                        type: string
                      - enum:
                        - webp
                        type: string
                scrollPage:
                  type: boolean
                selector:
                  type: string
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
      responses:
        '200':
          description: Returns the screenshot.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
            image/jpg:
              schema:
                description: JPEG binary.
                type: string
            image/png:
              schema:
                description: PNG binary.
                type: string
            image/webp:
              schema:
                description: WebP binary.
                type: string
            text/plain:
              schema:
                description: Base64 encoded.
                type: string
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: screenshot
  /accounts/{account_id}/browser-rendering/snapshot:
    post:
      operationId: brapi-post_Snapshot
      summary: Get HTML content and screenshot
      description: Returns the page's HTML content and screenshot. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.
      parameters:
      - name: account_id
        in: path
        description: Account ID.
        required: true
        schema:
          description: Account ID.
          type: string
      - name: cacheTTL
        in: query
        description: Cache TTL default is 5s. Set to 0 to disable.
        schema:
          description: Cache TTL default is 5s. Set to 0 to disable.
          type: number
          default: 5
          maximum: 86400
          minimum: 0
      - name: browser
        in: query
        description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
        schema:
          description: Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
          type: string
          enum:
          - kitesurf
      requestBody:
        required: true
        content:
          application/json:
            examples:
              example1:
                value:
                  formats:
                  - content
                  - screenshot
                  url: https://www.example.com/
            schema:
              type: object
              properties:
                actionTimeout:
                  description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.
                  type: number
                  maximum: 120000
                addScriptTag:
                  description: Adds a script element into the page with the desired URL or content.
                  type: array
                  items:
                    additionalProperties: false
                    properties:
                      content:
                        type: string
                      id:
                        type: string
                      type:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                addStyleTag:
                  description: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
                  type: array
                  items:
                    properties:
                      content:
                        type: string
                      url:
                        type: string
                        format: uri
                    type: object
                allowRequestPattern:
                  description: Only allow requests that match the provided regex patterns, eg. '/^.*\.(css)'. Reject rules are applied first.
                  type: array
                  items:
                    type: string
                allowResourceTypes:
                  description: Only allow requests that match the provided resource types, eg. 'image' or 'script'. Reject rules are applied first.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                authenticate:
                  description: Provide credentials for HTTP authentication.
                  type: object
                  properties:
                    password:
                      type: string
                      minLength: 1
                      x-sensitive: true
                    username:
                      type: string
                      minLength: 1
                  required:
                  - username
                  - password
                bestAttempt:
                  description: Attempt to proceed when 'awaited' events fail or timeout.
                  type: boolean
                cookies:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
                  type: array
                  items:
                    properties:
                      domain:
                        type: string
                      expires:
                        type: number
                      httpOnly:
                        type: boolean
                      name:
                        description: Cookie name.
                        type: string
                      partitionKey:
                        type: string
                      path:
                        type: string
                      priority:
                        anyOf:
                        - enum:
                          - Low
                          type: string
                        - enum:
                          - Medium
                          type: string
                        - enum:
                          - High
                          type: string
                      sameParty:
                        type: boolean
                      sameSite:
                        anyOf:
                        - enum:
                          - Strict
                          type: string
                        - enum:
                          - Lax
                          type: string
                        - enum:
                          - None
                          type: string
                      secure:
                        type: boolean
                      sourcePort:
                        type: number
                      sourceScheme:
                        anyOf:
                        - enum:
                          - Unset
                          type: string
                        - enum:
                          - NonSecure
                          type: string
                        - enum:
                          - Secure
                          type: string
                      url:
                        type: string
                      value:
                        type: string
                    required:
                    - name
                    - value
                    type: object
                emulateMediaType:
                  type: string
                formats:
                  type: array
                  items:
                    enum:
                    - content
                    - screenshot
                    - markdown
                    - accessibilityTree
                    type: string
                  default:
                  - content
                  - screenshot
                gotoOptions:
                  description: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
                  type: object
                  default: {}
                  properties:
                    referer:
                      type: string
                    referrerPolicy:
                      type: string
                    timeout:
                      type: number
                      default: 30000
                      maximum: 60000
                    waitUntil:
                      default: domcontentloaded
                      anyOf:
                      - enum:
                        - load
                        type: string
                      - enum:
                        - domcontentloaded
                        type: string
                      - enum:
                        - networkidle0
                        type: string
                      - enum:
                        - networkidle2
                        type: string
                      - items:
                          anyOf:
                          - enum:
                            - load
                            type: string
                          - enum:
                            - domcontentloaded
                            type: string
                          - enum:
                            - networkidle0
                            type: string
                          - enum:
                            - networkidle2
                            type: string
                        type: array
                html:
                  description: 'Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.'
                  type: string
                  example: <h1>Hello World!</h1>
                  minLength: 1
                rejectRequestPattern:
                  description: Block undesired requests that match the provided regex patterns, eg. '/^.*\.(css)'.
                  type: array
                  items:
                    type: string
                rejectResourceTypes:
                  description: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.
                  type: array
                  items:
                    anyOf:
                    - enum:
                      - document
                      type: string
                    - enum:
                      - stylesheet
                      type: string
                    - enum:
                      - image
                      type: string
                    - enum:
                      - media
                      type: string
                    - enum:
                      - font
                      type: string
                    - enum:
                      - script
                      type: string
                    - enum:
                      - texttrack
                      type: string
                    - enum:
                      - xhr
                      type: string
                    - enum:
                      - fetch
                      type: string
                    - enum:
                      - prefetch
                      type: string
                    - enum:
                      - eventsource
                      type: string
                    - enum:
                      - websocket
                      type: string
                    - enum:
                      - manifest
                      type: string
                    - enum:
                      - signedexchange
                      type: string
                    - enum:
                      - ping
                      type: string
                    - enum:
                      - cspviolationreport
                      type: string
                    - enum:
                      - preflight
                      type: string
                    - enum:
                      - other
                      type: string
                screenshotOptions:
                  type: object
                  default: {}
                  additionalProperties: false
                  properties:
                    captureBeyondViewport:
                      type: boolean
                    clip:
                      type: object
                      properties:
                        height:
                          type: number
                        scale:
                          type: number
                        width:
                          type: number
                        x:
                          type: number
                        y:
                          type: number
                      required:
                      - x
                      - y
                      - width
                      - height
                    fromSurface:
                      type: boolean
                    fullPage:
                      type: boolean
                    omitBackground:
                      type: boolean
                    optimizeForSpeed:
                      type: boolean
                    quality:
                      type: number
                    type:
                      default: png
                      anyOf:
                      - enum:
                        - png
                        type: string
                      - enum:
                        - jpeg
                        type: string
                      - enum:
                        - webp
                        type: string
                setExtraHTTPHeaders:
                  type: object
                  additionalProperties:
                    type: string
                setJavaScriptEnabled:
                  type: boolean
                url:
                  description: URL to navigate to, eg. `https://example.com`.
                  type: string
                  format: uri
                  example: https://example.com/
                userAgent:
                  type: string
                  default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36
                viewport:
                  description: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
                  type: object
                  default:
                    height: 1080
                    width: 1920
                  properties:
                    deviceScaleFactor:
                      type: number
                    hasTouch:
                      type: boolean
                    height:
                      type: number
                    isLandscape:
                      type: boolean
                    isMobile:
                      type: boolean
                    width:
                      type: number
                  required:
                  - width
                  - height
                waitForSelector:
                  description: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
                  type: object
                  properties:
                    hidden:
                      type: boolean
                      enum:
                      - true
                    selector:
                      type: string
                    timeout:
                      type: number
                      maximum: 120000
                    visible:
                      type: boolean
                      enum:
                      - true
                  required:
                  - selector
                waitForTimeout:
                  description: Waits for a specified timeout before continuing.
                  type: number
                  maximum: 120000
              additionalProperties: false
              oneOf:
              - not:
                  properties:
                    html:
                      type: string
                  required:
                  - html
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - url
                type: object
              - not:
                  properties:
                    url:
                      type: string
                  required:
                  - url
                  type: object
                properties:
                  html:
                    type: string
                  url:
                    type: string
                required:
                - html
                type: object
      responses:
        '200':
          description: Returns the requested formats information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  meta:
                    type: object
                    properties:
                      finalUrl:
                        description: URL that served the response, after any redirects the browser followed.
                        type: string
                      headers:
                        description: Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted.
                        type: object
                        additionalProperties:
                          type: string
                      redirectChain:
                        description: HTTP redirects followed to reach `finalUrl`, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read.
                        type: array
                        items:
                          properties:
                            headers:
                              description: Redirect response headers, including `location`.
                              type: object
                              additionalProperties:
                                type: string
                            status:
                              description: HTTP status of the redirect.
                              type: number
                            url:
                              description: URL that returned the redirect.
                              type: string
                          required:
                          - url
                          - status
                          - headers
                          type: object
                      status:
                        description: HTTP status returned by the origin.
                        type: number
                      title:
                        description: Page title.
                        type: string
                  result:
                    type: object
                    properties:
                      accessibilityTree:
                        $ref: '#/components/schemas/brapi_SerializedAXNode'
                      content:
                        description: HTML content.
                        type: string
                      markdown:
                        description: Markdown content. Prefixed with YAML frontmatter (e.g. `title`) when the page provides that metadata.
                        type: string
                      screenshot:
                        description: Base64 encoded image.
                        type: string
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
                - meta
        '400':
          description: The request contains errors or didn't properly encode content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '422':
          description: Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '429':
          description: Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                description: Number of seconds to wait before retrying the request.
                type: number
                example: 60
          content:
            application/json:
              example:
                errors:
                - code: 2001
                  message: Rate limit exceeded
                success: false
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        code:
                          description: Error code.
                          type: number
                        message:
                          description: Error message.
                          type: string
                      required:
                      - message
                      - code
                      type: object
                  success:
                    description: Response status.
                    type: boolean
                required:
                - success
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - brapi
      x-api-token-group:
      - Browser Rendering Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.brapi.read
        type: string
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: browser-run.quick-action
      x-fern-sdk-method-name: snapshot
components:
  schemas:
    brapi_SerializedAXNode:
      description: Accessibility tree node
      type: object
      properties:
        autocomplete:
          type: string
        checked:
          oneOf:
          - type: boolean
          - enum:
            - mixed
            type: string
        children:
          type: array
          items:
            $ref: '#/components/schemas/brapi_SerializedAXNode'
        description:
          type: string
        disabled:
          type: boolean
        expanded:
          type: boolean
        focused:
          type: boolean
        haspopup:
          type: string
        invalid:
          type: string
        keyshortcuts:
          type: string
        level:
          type: number
        modal:
          type: boolean
        multiline:
          type: boolean
        multiselectable:
          type: boolean
        name:
          type: string
        orientation:
          type: string
        pressed:
          oneOf:
          - type: boolean
          - enum:
            - mixed
            type: string
        readonly:
          type: boolean
        required:
          type: boolean
        role:
          type: string
        roledescription:
          type: string
        selected:
          type: boolean
        value:
          oneOf:
          - type: string
          - type: number
        valuemax:
          type: number
        valuemin:
          type: number
        valuetext:
          type: string
      required:
      - role
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey
externalDocs:
  description: Cloudflare Radar Documentation
  url: https://developers.cloudflare.com/radar/
x-forge-commands:
  abuse-reports:
    description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites
    groups:
      appeals:
        description: Appeal eligibility for abuse reports
      emails:
        description: Emails sent for abuse reports
      mitigations:
        description: Mitigation actions taken in response to abuse reports
  accounts:
    description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account
    groups:
      applications:
        description: Applications operations
      categories:
        description: Categories operations
      organizations:
        description: Move accounts between organizations
      profile:
        description: View and manage the profile for a Cloudflare account
      roles:
        description: View the roles available for assigning to account members, each defining a set of permissions
      subscriptions:
        description: View and manage plan subscriptions attached to this account
      tokens:
        description: Create and manage scoped API tokens for programmatic access to the Cloudflare API
  ai-gateway:
    description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more
    groups:
      custom-domains:
        description: Manage custom hostnames that route requests through an AI Gateway
      custom-providers:
        description: Manage account-level custom AI providers and their endpoint settings
      datasets:
        description: 'Deprecated: manage filtered collections of gateway logs used by evaluations'
      dynamic-routing:
        description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments
      dynamic-routing.deployments:
        description: Deploy dynamic route versions and view deployment history
      dynamic-routing.versions:
        description: Create and inspect saved versions of a dynamic route
      evaluation-types:
        description: 'Deprecated: list the evaluator types that evaluations can use'
      evaluations:
        description: 'Deprecated: score the logs in a dataset with selected evaluator types'
      gateways:
        description: Create and configure AI Gateways for an account
      gateways.providers:
        description: Store and rotate upstream AI provider keys for a gateway
      logs:
        description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs
  ai-search:
    description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions'
    groups:
      items:
        description: Content indexed by AI Search instances
      jobs:
        description: Indexing job lifecycle for AI Search instances
      namespace:
        description: Logical groupings for organizing AI Search instances
      tokens:
        description: Credentials used by AI Search instances
  ai-security:
    description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications
    groups:
      custom-topics:
        description: Organization-specific topic categories used by AI Security for Apps content detection
  analytics:
    description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics
    groups:
      colo:
        description: Per-data-center (colo) traffic analytics breakdown for the zone
      dashboard:
        description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views
      latency:
        description: Argo Smart Routing latency analytics showing time-to-first-byte improvements
  argo:
    description: Network optimization features that speed up and improve reliability of traffic to your origins
    groups:
      smart-routing:
        description: Route traffic through the fastest network paths to your origin using real-time latency data
      tiered-caching:
        description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin
  basin-catalog:
    description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines
    groups:
      credentials:
        description: Catalog access credentials for external query engines (Spark, Trino, etc.)
      maintenance-configs:
        description: Table maintenance settings — compaction schedules and snapshot expiration policies
      namespaces:
        description: Logical namespaces that group related tables within the data catalog
      namespaces.tables:
        description: Tables within catalog namespaces
      namespaces.tables.maintenance-configs:
        description: Table-level maintenance configurations and operations
      namespaces.tables.maintenance-runs:
        description: History of maintenance runs performed on tables
  billing:
    description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services
    groups:
      profiles:
        description: Billing profile with payment method, address, and invoice preferences
      usage:
        description: Metered usage data for billed services — requests, bandwidth, and feature consumption
  botnet-feed:
    description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure
    groups:
      asn:
        description: ASN-level botnet activity data showing networks with known C2 infrastructure
      configs:
        description: Botnet feed subscription configuration and notification preferences
  builds:
    description: Build and deploy Workers from connected repositories, then inspect build status and logs.
    groups:
      deploy-hooks:
        description: Manage branch-specific HTTP hooks that start builds.
      limits:
        description: View build-minute availability and refresh information.
      logs:
        description: Retrieve build logs.
      repos:
        description: Manage source repository connections for Workers Builds.
      tokens:
        description: Manage credentials used by Workers Builds to deploy Workers.
      triggers:
        description: Configure how repository changes build and deploy Workers.
      versions:
        description: Find builds associated with Worker versions.
      workers:
        description: Manage repository-backed build configuration for Workers.
  cache:
    description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving
    groups:
      origin-cloud-regions:
        description: Manage Origin Cloud Regions routing and failover configurations
      settings:
        description: Configure Cache Reserve, tiered caching, and variant serving
      settings.regional-tiered-cache:
        description: Restrict tiered cache topology to data centers within a specific geographic region
      settings.reserve:
        description: Persistent storage tier that keeps cached assets even after eviction from edge caches
      settings.smart-tiered-cache:
        description: Automatically determine the best upper-tier data centers for tiered cache topology
      settings.variants:
        description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.)
  client-side-security:
    description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks
    groups:
      connections:
        description: Third-party connections made by scripts on your pages — track data exfiltration risks
      cookies:
        description: Cookies set by your pages with classification and same-site attribute tracking
      policies:
        description: Content Security Policies that control which scripts and connections are allowed on your pages
      scripts:
        description: JavaScript files detected on your pages with change tracking and malicious code detection
      settings:
        description: Fine tune Client-Side Security behaviors
  cloud-connector:
    description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers
    groups:
      rules:
        description: Routing rules that map request patterns to cloud provider endpoints
  cloudforce-one:
    description: Detection rule management APIs
    groups:
      binary-storage:
        description: Upload and retrieve malware samples and suspicious binaries for analysis
      requests:
        description: Additional request operations — priority listing and asset creation
      rules:
        description: Rule management operations
        groups:
          approvals:
            description: Approval workflow operations
          email:
            description: Email rule operations
          exemptions:
            description: Exemption rule operations
          managed:
            description: Managed rule operations
          stats:
            description: Rule statistics operations
          tree:
            description: Rule navigation tree operations
      scans:
        description: Scan URLs, IPs, and domains for threat intelligence indicators
  containers:
    description: Deploy and manage Containers applications on Cloudflare's global network
    groups:
      applications:
        description: Manage Containers applications
      applications.instances:
        description: Inspect Containers instances belonging to applications
      applications.rollouts:
        description: Manage rollouts for scheduler-backed applications
      applications.versions:
        description: Inspect versions of scheduler-backed applications
      registries:
        description: Manage Containers image registries
      registries.credentials:
        description: Generate image registry credentials
  content-scan:
    description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads
    groups:
      expressions:
        description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own
  custom-pages:
    description: Manage custom error and challenge pages and their assets for accounts and zones
    groups:
      account-custom-pages:
        description: Manage account-level custom pages
      account-custom-pages.preview-tokens:
        description: Preview tokens for account-level custom pages
      assets:
        description: Manage account- and zone-level custom assets
      zone-custom-pages:
        description: Manage zone-level custom pages
      zone-custom-pages.preview-tokens:
        description: Preview tokens for zone-level custom pages
  d1:
    description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access.
    groups:
      time-travel:
        description: use specific point-in-time backups of your D1 database
        x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel
  diagnostics:
    description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks
    groups:
      endpoint-healthchecks:
        description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks
      traceroutes:
        description: Run traceroutes from Cloudflare data centers to diagnose network path issues
  email-routing:
    description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records
    groups:
      addresses:
        description: Verified destination email addresses that can receive forwarded mail
      dns:
        description: Inspect or unlock the DNS records required by Email Routing
      rules:
        description: Match incoming email addresses and forward messages to destination mailboxes or Workers
      settings:
        description: Inspect and update Email Routing settings
  email-security:
    description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing
    groups:
      analytics:
        description: Analytics and reporting — monthly report and per-day breakdowns of threat activity
      bulk-actions:
        description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs
      investigate:
        description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions
      phishguard:
        description: PhishGuard user-reported phishing reports — view detected threats for a date range
      settings:
        description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling
      submissions:
        description: Reclassify submissions — track user and team reports of false positives and missed detections
  email-sending:
    description: Send transactional email and manage sending subdomains and their DNS configuration
    groups:
      limits:
        description: Inspect account-level sending quotas and current usage
      subdomains:
        description: Configure sending subdomains and keep their DNS records healthy
      suppressions:
        description: Prevent delivery to suppressed addresses and manage the account suppression list
  filters:
    description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations
  firewall:
    description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages
    groups:
      access-rules:
        description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone
      lockdowns:
        description: Zone lockdown rules that restrict access to URLs by IP address or range
      rules:
        description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations
      ua-rules:
        description: Block or challenge requests based on the User-Agent header string
      waf:
        description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations
      zone-access-rules:
        description: Zone-scoped IP access rules for blocking or allowing traffic
  google-tag-gateway:
    description: Google Tag Gateway operations
    groups:
      config:
        description: Google Tag Gateway config operations
  healthchecks:
    description: Standalone health checks that monitor origin server availability from Cloudflare's edge
    groups:
      previews:
        description: Test a health check configuration before deploying it to production
  hyperdrive:
    description: Accelerate access to existing databases by caching queries and pooling connections at the edge
  iam:
    description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors
    groups:
      permission-groups:
        description: View the permission groups that can be assigned to API tokens and policies
      resource-groups:
        description: Define scopes that limit which account resources a policy or token can access
      sso:
        description: Configure single sign-on connectors to authenticate account members through an external identity provider
      user-groups:
        description: Organize account members into groups for easier permission assignment
  images:
    description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads
    groups:
      flows:
        description: Zone-level transformation flows that control how images are resized and optimized on delivery
      import:
        description: Import images from S3
      keys:
        description: Manage signing keys for generating private image URLs
      variants:
        description: Manage named resize variants for transforming images on delivery
  intel:
    description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds
    groups:
      asn:
        description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems
      attack-surface-report:
        description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping
      dns:
        description: Passive DNS data showing historical DNS resolution records for domains
      domain-history:
        description: Historical domain registration and categorization changes over time
      domains:
        description: Domain intelligence — risk scores, categories, and associated infrastructure
      indicator-feeds:
        description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs
      ip-lists:
        description: Curated IP lists used for threat detection and policy enforcement
      ips:
        description: IP address intelligence — geolocation, risk assessment, and hosting provider details
      miscategorizations:
        description: Report and track domain miscategorization corrections
      whois:
        description: WHOIS registration data for domains including registrant, registrar, and nameservers
  k2:
    description: Durable, ordered event streams that you produce records to and consume from with subscriptions
    groups:
      streams:
        description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records
      streams.subscriptions:
        description: Subscriptions that consume a K2 stream, with committed-position lag
  leaked-credential-checks:
    description: Detect compromised credentials in login requests by checking against known breach databases
    groups:
      detections:
        description: Custom detection locations that tell the WAF where to find usernames and passwords in requests
  load-balancers:
    description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover
    groups:
      monitor-groups:
        description: Group monitors together for shared configuration and bulk management
      monitor-groups.references:
        description: List references to monitor groups used by load balancer pools
      monitors:
        description: Health check configurations that probe origin servers and determine pool availability
      monitors.previews:
        description: Health check configurations that probe origin servers and determine pool availability
      monitors.references:
        description: Health check configurations that probe origin servers and determine pool availability
      pools:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      pools.health:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      pools.references:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      previews:
        description: Preview the result of a health check monitor configuration before applying it
      regions:
        description: Geographic regions used for regional pool steering and traffic policies
      searches:
        description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference
  logs:
    description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields
    groups:
      control:
        description: Log control operations
      received:
        description: Received log operations
  magic-network-monitoring:
    description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion
    groups:
      configs:
        description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings
      rules:
        description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements
      vpc-flows:
        description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection
  magic-transit:
    description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures
    groups:
      advanced-dns-protection:
        description: Advanced Dns Protection operations
      advanced-tcp-protection:
        description: Advanced Tcp Protection operations
      apps:
        description: Application-aware traffic policies for Magic WAN that steer traffic by app type
      bgp-filter-profiles:
        description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels
      bgp-settings:
        description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels
      cf-interconnects:
        description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering
      gre-tunnels:
        description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit
      ipsec-tunnels:
        description: IPsec tunnel endpoints with pre-shared key management for encrypted transit
      pcaps:
        description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels
      routes:
        description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels
      sites:
        description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config
  mcp:
    description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls
    groups:
      portals:
        description: Manage MCP portals, attached servers, and Code Mode settings
      servers:
        description: Manage upstream MCP servers, credentials, capabilities, and sync state
  network-interconnects:
    description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network
    groups:
      cnis:
        description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare
      interconnects:
        description: Physical cross-connect and partner interconnect sessions with LOA and status tracking
      settings:
        description: Account-level interconnect settings and default configurations
      slots:
        description: Available interconnect facility slots showing port capacity at Cloudflare data centers
  organizations:
    description: Multi-user organizations that group accounts, members, and shared settings under a single entity
    groups:
      account-organizations:
        description: List organizations associated with a specific account
      accounts:
        description: Accounts operations
      members:
        description: Members operations
      members-batch-create:
        description: Members Batch Create operations
      organization-profile:
        description: View and update the public profile information for an organization
      shares:
        description: Shares operations
  origin-post-quantum-encryption:
    description: Enable post-quantum key exchange for connections between Cloudflare and your origin server
  pages:
    description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains
    groups:
      projects:
        description: Pages projects, deployments, build logs, and custom domain bindings
  pipelines:
    description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time
    groups:
      sinks:
        description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage
      streams:
        description: Inbound data streams that feed events into a pipeline for processing
  precursor:
    description: Precursor settings for a zone
  queues:
    description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale
    groups:
      consumers:
        description: Workers that automatically receive and process messages from a queue
      messages:
        description: Push messages to a queue and pull or acknowledge them from consumers
      purge:
        description: Remove all pending messages from a queue
      subscriptions:
        description: Manage queue subscriptions for event-driven message routing
  r2:
    description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration
    groups:
      buckets:
        description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks
      buckets.jobs:
        description: Create and inspect background jobs for an R2 bucket
      buckets.local-uploads:
        description: R2 bucket local upload configuration
      super-slurper:
        description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs
      temporary-credentials:
        description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations
  r2-data-catalog:
    description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines
    groups:
      credentials:
        description: Catalog access credentials for external query engines (Spark, Trino, etc.)
      maintenance-configs:
        description: Table maintenance settings — compaction schedules and snapshot expiration policies
      namespaces:
        description: Logical namespaces that group related tables within the data catalog
      namespaces.tables:
        description: Tables within catalog namespaces
      namespaces.tables.maintenance-configs:
        description: Table-level maintenance configurations and operations
      namespaces.tables.maintenance-runs:
        description: History of maintenance runs performed on tables
  radar:
    description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights
    groups:
      agent-readiness:
        description: Agent readiness summary statistics across the Cloudflare network
      ai:
        description: AI inference trends and model usage statistics across the Cloudflare network
      annotations:
        description: Radar annotations marking significant Internet events (outages, cable cuts, etc.)
      as112:
        description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space
      attacks:
        description: DDoS and application-layer attack trends, vectors, and target analysis
      bgp:
        description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events
      bots:
        description: Internet-wide bot traffic trends, categories, and distribution statistics
      ct:
        description: Certificate Transparency log monitoring and newly-issued certificate discovery
      datasets:
        description: Downloadable Radar datasets for offline analysis and research
      dns:
        description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption
      email:
        description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics
      entities:
        description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries
      geolocations:
        description: Geographic location metadata used for regional traffic analysis
      http:
        description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution
      leaked-credentials:
        description: Leaked credential detection trends and exposure statistics
      netflows:
        description: Network-layer traffic flow data and volumetric trend analysis
      origins:
        description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics
      post-quantum:
        description: Post-quantum encryption adoption and deployment trends across the Internet
      quality:
        description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN
      ranking:
        description: Top domain rankings based on DNS query popularity across the Cloudflare network
      robots-txt:
        description: Robots.txt adoption and crawler directive trends across the web
      search:
        description: Search Radar data across IPs, ASNs, domains, and locations
      tcp-resets-timeouts:
        description: TCP connection reset and timeout statistics indicating network health issues
      tlds:
        description: Top-level domain (TLD) metadata and performance trends
      traffic-anomalies:
        description: Detected traffic anomalies and unusual patterns in Internet traffic flows
      verified-bots:
        description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns
  rate-limits:
    description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations
  realtime:
    description: Real-time audio, video, and data services on Cloudflare's global network
    groups:
      kit:
        description: SDK-backed meetings, participants, recordings, livestreams, and webhooks
      kit.analytics:
        description: Usage and livestream analytics for RealtimeKit applications
      kit.analytics.livestreams:
        description: Livestream analytics for RealtimeKit applications
      kit.analytics.livestreams.daily:
        description: Daily livestream analytics for RealtimeKit applications
      kit.analytics.usage:
        description: Usage analytics for RealtimeKit applications
      kit.apps:
        description: RealtimeKit applications that group meetings, sessions, and configuration
      kit.livestreams:
        description: Independent and meeting-based livestreams and their sessions
      kit.livestreams.sessions:
        description: Sessions for RealtimeKit livestreams
      kit.meetings:
        description: Meetings, participants, access tokens, and meeting livestreams
      kit.meetings.active:
        description: Live meeting state and participant controls
      kit.meetings.active.polls:
        description: Polls for active meeting sessions
      kit.meetings.livestream:
        description: Livestream operations associated with RealtimeKit meetings
      kit.meetings.participants:
        description: Participants in RealtimeKit meetings
      kit.meetings.participants.tokens:
        description: Access tokens for RealtimeKit meeting participants
      kit.presets:
        description: Reusable meeting configuration for media, permissions, and interface behavior
      kit.recordings:
        description: Meeting and participant-track recordings and recording controls
      kit.recordings.active:
        description: Active recordings for RealtimeKit meetings
      kit.recordings.tracks:
        description: Participant-track recordings for RealtimeKit meetings
      kit.sessions:
        description: Historical session data, participants, chat, transcripts, and summaries
      kit.sessions.chat:
        description: Chat messages from historical RealtimeKit sessions
      kit.sessions.livestreams:
        description: Livestreams associated with historical RealtimeKit sessions
      kit.sessions.participants:
        description: Participants in historical RealtimeKit sessions
      kit.sessions.peers:
        description: Peer details from historical RealtimeKit sessions
      kit.sessions.summaries:
        description: Summaries of historical RealtimeKit sessions
      kit.sessions.transcripts:
        description: Transcripts from historical RealtimeKit sessions
      kit.webhooks:
        description: Webhook endpoints and supported events for RealtimeKit notifications
      kit.webhooks.events:
        description: Supported events for RealtimeKit webhooks
      moq:
        description: MoQ relays for publishing and subscribing to media streams
      moq.relays:
        description: Relays are isolated MoQ scopes that carry media between publishers and subscribers
      moq.relays.tokens:
        description: Tokens that authorize publishers and subscribers to connect to a relay
      sfu:
        description: SFU apps that route WebRTC media and data between participants
      sfu.apps:
        description: SFU application namespaces for sessions and tracks
      turn:
        description: TURN keys that help clients traverse NATs and firewalls
      turn.keys:
        description: Keys used to generate short-lived TURN credentials
  request-tracers:
    description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline
    groups:
      traces:
        description: Simulate request processing to debug rule matches, transforms, and routing decisions
  resource-sharing:
    description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls
    groups:
      recipients:
        description: Update share recipients
      resources:
        description: Individual resources (zones, configs) that have been shared with recipients
  rules:
    description: Resources used by Cloudflare rules and rulesets
    groups:
      lists:
        description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions
  rum:
    description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics
    groups:
      rules:
        description: Rules that control which pages and paths are tracked by Web Analytics
      site-info:
        description: Web Analytics sites — register domains and get the JavaScript beacon snippet
  scim:
    description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account
    groups:
      groups:
        description: Groups operations
      resource-types:
        description: Resource Types operations
      schemas:
        description: Schemas operations
      service-provider-config:
        description: Service Provider Config operations
      users:
        description: Users operations
  secrets-store:
    description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products
    groups:
      quota:
        description: Account quota limits for secrets stores, secrets count, and storage capacity
      secrets:
        description: Encrypted key-value secrets within a store. Pass --store-id to scope.
      stores:
        description: Secret stores that hold encrypted key-value secrets accessible by Workers and services
  security-center:
    description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities
    groups:
      insights:
        description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc.
      zone-insights:
        description: Zone-scoped security insights — counts by class, severity, type, and dismissal
  security-txt:
    description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities
  smart-shield:
    description: Smart Shield settings, health checks, and cache reserve management
    groups:
      cache-reserve-clear:
        description: Cache Reserve Clear operations
      health-checks:
        description: Health checks operations
  spectrum:
    description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation
    groups:
      analytics:
        description: Real-time and historical connection analytics for Spectrum applications
      apps:
        description: Spectrum application configurations that map protocols and ports to origin servers
  speed:
    description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests
    groups:
      availabilities:
        description: Check which speed test regions and configurations are available for your zone
      pages:
        description: Tested pages with their performance history, trends, and individual test results
      schedule:
        description: Scheduled recurring speed tests that automatically run at regular intervals
  ssl:
    description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations
    groups:
      automatic-upgrader:
        description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings
      recommendations:
        description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration
  stream:
    description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale
    groups:
      audio-tracks:
        description: Add, edit, or remove additional audio tracks on a video
      captions:
        description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages
      clip:
        description: Create a new video clip from an existing video by specifying start and end times
      copy:
        description: Import a video from a URL into Stream for processing and delivery
      direct-upload:
        description: Generate a tokenized URL that lets end-users upload video directly to Stream
      downloads:
        description: Create downloadable MP4 renditions of a video for offline viewing
      embed:
        description: Retrieve the HTML embed code snippet for a video
      keys:
        description: Signing keys used to generate short-lived signed URLs for private video playback
      live-inputs:
        description: Enable and disable live input streams
      token:
        description: Generate short-lived signed URL tokens for secure private video playback
      typed-downloads:
        description: Type-specific stream download creation and deletion
      videos:
        description: Aggregate video storage usage statistics for the account
      watermarks:
        description: Watermark profiles that overlay an image on every video in the account
      webhooks:
        description: Webhook notifications for video lifecycle events (ready, error, etc.)
  tenants:
    description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships
    groups:
      account-types:
        description: Account Types operations
      accounts:
        description: Accounts operations
      entitlements:
        description: Entitlements operations
      memberships:
        description: Memberships operations
  turnstile:
    description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience
    groups:
      widgets:
        description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings
  url-scanner:
    description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results
    groups:
      response:
        description: Response operations
      responses:
        description: Raw HTTP response data captured during URL scans
      scan:
        description: Scan operations
      scans:
        description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts
  user:
    description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens
    groups:
      billing:
        description: View billing history and payment profile for your user (deprecated — prefer account-level billing)
      firewall:
        description: Firewall operations
      load-balancers.monitors:
        description: Load Balancers operations
      load-balancers.monitors.preview:
        description: Load Balancers operations
      load-balancers.monitors.references:
        description: Load Balancers operations
      load-balancers.pools:
        description: Load Balancers operations
      load-balancers.pools.edit.pools:
        description: Load Balancers operations
      load-balancers.pools.health:
        description: Load Balancers operations
      load-balancers.pools.preview:
        description: Load Balancers operations
      load-balancers.pools.references:
        description: Load Balancers operations
      load-balancers.preview:
        description: Load Balancers operations
      load-balancing-analytics.events:
        description: Load Balancing Analytics operations
      subscriptions:
        description: View and manage zone-level plan subscriptions owned by your user
      tenants:
        description: Tenants operations
      tokens:
        description: Create and manage personal API tokens scoped to your user for programmatic API access
  user.analytics:
    description: User-level traffic analytics — aggregated totals and timeseries across all zones
  vectorize:
    description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers
    groups:
      deprecated-indexes:
        description: Deprecated v1 Vectorize index operations
      metadata-index:
        description: Metadata indexes for filtered vector search
  waiting-rooms:
    description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages
    groups:
      account-waiting-rooms:
        description: Account-scoped waiting room listing
      events:
        description: Scheduled events that temporarily override waiting room settings for sales, launches, etc.
      page:
        description: Custom HTML waiting page templates and preview rendering
      rules:
        description: Rules that bypass or modify waiting room behavior for specific request patterns
      settings:
        description: Zone-level waiting room defaults and cookie configuration
      statuses:
        description: Real-time queue status showing active users, queued users, and estimated wait times
  workflows:
    description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence
    groups:
      instances:
        description: Workflow instance operations
      versions:
        description: Workflow version operations
  zaraz:
    description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS
    groups:
      config:
        description: Full Zaraz configuration including tools, triggers, and variables for the zone
      default:
        description: Default Zaraz configuration template used as a starting point for new zones
      export:
        description: Export the current Zaraz configuration as a portable JSON document
      history:
        description: Configuration version history — browse and restore previous Zaraz configurations
      publish:
        description: Publish pending Zaraz configuration changes to make them live on the zone
      workflow:
        description: Workflow state for Zaraz configuration changes (draft vs. published)
  zero-trust:
    description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation
    groups:
      dex:
        description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics
      dlp.custom-prompt-topics:
        description: Data Loss Prevention - manage custom prompt topics for AI-based content detection
      dlp.data-classes:
        description: Data Loss Prevention - manage data classes used to classify sensitive information
      dlp.data-tag-categories:
        description: Data Loss Prevention - manage categories that organize data tags
      dlp.data-tag-category-templates:
        description: Data Loss Prevention - browse templates for creating data tag categories
      dlp.data-tags:
        description: Data Loss Prevention - manage tags used to classify and organize sensitive data
      dlp.datasets:
        description: Data Loss Prevention - manage datasets, versions, and uploads
      dlp.document-fingerprints:
        description: Data Loss Prevention - manage document fingerprints for detecting matching documents
      dlp.email.account-mapping:
        description: Data Loss Prevention - configure account mappings for outbound email scanning
      dlp.email.rules:
        description: Data Loss Prevention - manage outbound email scanning rules and their priorities
      dlp.entries:
        description: Data Loss Prevention - list and manage detection entries
      dlp.limits:
        description: Data Loss Prevention - view account limits and resource quotas
      dlp.patterns:
        description: Data Loss Prevention - validate regular expressions used for content detection
      dlp.profiles:
        description: Data Loss Prevention - list and retrieve profiles
      dlp.profiles.custom:
        description: Data Loss Prevention - manage custom profiles
      dlp.profiles.predefined:
        description: Data Loss Prevention - manage predefined profiles
      dlp.sensitivity-group-templates:
        description: Data Loss Prevention - browse templates for creating sensitivity groups
      dlp.sensitivity-groups:
        description: Data Loss Prevention - manage sensitivity groups and their level ordering
      dlp.sensitivity-levels:
        description: Data Loss Prevention - manage sensitivity levels within sensitivity groups
      dlp.settings:
        description: Data Loss Prevention - manage account-level settings
      dlp.validators:
        description: Data Loss Prevention - list and retrieve content validators
      dlp.validators.proximity-words:
        description: Data Loss Prevention - manage proximity-word validators
      risk-scoring:
        description: User Risk Scoring - retrieve and reset user risk scores
      risk-scoring.behaviours:
        description: User Risk Scoring - manage behaviors used to calculate user risk scores
      risk-scoring.integrations:
        description: User Risk Scoring - manage integrations that provide risk score signals
      risk-scoring.integrations.references:
        description: User Risk Scoring - retrieve integrations by external reference
      risk-scoring.summary:
        description: User Risk Scoring - retrieve account risk score summaries
  zones:
    description: Zones are domains on Cloudflare — list, create, and configure domain settings
    groups:
      aegis:
        description: Aegis operations
      fonts:
        description: Fonts operations
      origin-h2-max-streams:
        description: Origin H2 Max Streams operations
      origin-max-http-version:
        description: Origin Max Http Version operations
      origin-tls-compliance-modes:
        description: Manage zone Origin TLS Compliance Modes setting
      rum:
        description: Rum operations
      speed-brain:
        description: Speed Brain operations