# Accessibility Tree

## Get accessibility tree page

`client.browserRendering.accessibilityTree.create(AccessibilityTreeCreateParamsparams, RequestOptionsoptions?): AccessibilityTreeCreateResponse`

**post** `/accounts/{account_id}/browser-rendering/accessibilityTree`

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

- `params: AccessibilityTreeCreateParams`

  - `account_id: string`

    Path param: Account ID.

  - `cacheTTL?: number`

    Query param: Cache TTL default is 5s. Set to 0 to disable.

  - `actionTimeout?: number`

    Body param: 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.

  - `addScriptTag?: Array<AddScriptTag>`

    Body param: Adds a `<script>` tag into the page with the desired URL or content.

    - `id?: string`

    - `content?: string`

    - `type?: string`

    - `url?: string`

  - `addStyleTag?: Array<AddStyleTag>`

    Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.

    - `content?: string`

    - `url?: string`

  - `allowRequestPattern?: Array<string>`

    Body param: Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'.

  - `allowResourceTypes?: Array<"document" | "stylesheet" | "image" | 15 more>`

    Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'.

    - `"document"`

    - `"stylesheet"`

    - `"image"`

    - `"media"`

    - `"font"`

    - `"script"`

    - `"texttrack"`

    - `"xhr"`

    - `"fetch"`

    - `"prefetch"`

    - `"eventsource"`

    - `"websocket"`

    - `"manifest"`

    - `"signedexchange"`

    - `"ping"`

    - `"cspviolationreport"`

    - `"preflight"`

    - `"other"`

  - `authenticate?: Authenticate`

    Body param: Provide credentials for HTTP authentication.

    - `password: string`

    - `username: string`

  - `bestAttempt?: boolean`

    Body param: Attempt to proceed when 'awaited' events fail or timeout.

  - `cookies?: Array<Cookie>`

    Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).

    - `name: string`

      Cookie name.

    - `value: string`

    - `domain?: string`

    - `expires?: number`

    - `httpOnly?: boolean`

    - `partitionKey?: string`

    - `path?: string`

    - `priority?: "Low" | "Medium" | "High"`

      - `"Low"`

      - `"Medium"`

      - `"High"`

    - `sameParty?: boolean`

    - `sameSite?: "Strict" | "Lax" | "None"`

      - `"Strict"`

      - `"Lax"`

      - `"None"`

    - `secure?: boolean`

    - `sourcePort?: number`

    - `sourceScheme?: "Unset" | "NonSecure" | "Secure"`

      - `"Unset"`

      - `"NonSecure"`

      - `"Secure"`

    - `url?: string`

  - `emulateMediaType?: string`

    Body param

  - `gotoOptions?: GotoOptions`

    Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions).

    - `referer?: string`

    - `referrerPolicy?: string`

    - `timeout?: number`

    - `waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | Array<"load" | "domcontentloaded" | "networkidle0" | "networkidle2">`

      - `"load" | "domcontentloaded" | "networkidle0" | "networkidle2"`

        - `"load"`

        - `"domcontentloaded"`

        - `"networkidle0"`

        - `"networkidle2"`

      - `Array<"load" | "domcontentloaded" | "networkidle0" | "networkidle2">`

        - `"load"`

        - `"domcontentloaded"`

        - `"networkidle0"`

        - `"networkidle2"`

  - `html?: string`

    Body param: Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.

  - `interestingOnly?: boolean`

    Body param

  - `rejectRequestPattern?: Array<string>`

    Body param: Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.

  - `rejectResourceTypes?: Array<"document" | "stylesheet" | "image" | 15 more>`

    Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.

    - `"document"`

    - `"stylesheet"`

    - `"image"`

    - `"media"`

    - `"font"`

    - `"script"`

    - `"texttrack"`

    - `"xhr"`

    - `"fetch"`

    - `"prefetch"`

    - `"eventsource"`

    - `"websocket"`

    - `"manifest"`

    - `"signedexchange"`

    - `"ping"`

    - `"cspviolationreport"`

    - `"preflight"`

    - `"other"`

  - `root?: string`

    Body param

  - `setExtraHTTPHeaders?: Record<string, string>`

    Body param

  - `setJavaScriptEnabled?: boolean`

    Body param

  - `url?: string`

    Body param: URL to navigate to, eg. `https://example.com`.

  - `userAgent?: string`

    Body param

  - `viewport?: Viewport`

    Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).

    - `height: number`

    - `width: number`

    - `deviceScaleFactor?: number`

    - `hasTouch?: boolean`

    - `isLandscape?: boolean`

    - `isMobile?: boolean`

  - `waitForSelector?: WaitForSelector`

    Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).

    - `selector: string`

    - `hidden?: true`

      - `true`

    - `timeout?: number`

    - `visible?: true`

      - `true`

  - `waitForTimeout?: number`

    Body param: Waits for a specified timeout before continuing.

### Returns

- `AccessibilityTreeCreateResponse`

  - `accessibilityTree: AccessibilityTree | null`

    Accessibility tree node

    - `role: string`

    - `autocomplete?: string`

    - `checked?: boolean | "mixed"`

      - `boolean`

      - `"mixed"`

        - `"mixed"`

    - `children?: Array<unknown>`

    - `description?: string`

    - `disabled?: boolean`

    - `expanded?: boolean`

    - `focused?: boolean`

    - `haspopup?: string`

    - `invalid?: string`

    - `keyshortcuts?: string`

    - `level?: number`

    - `modal?: boolean`

    - `multiline?: boolean`

    - `multiselectable?: boolean`

    - `name?: string`

    - `orientation?: string`

    - `pressed?: boolean | "mixed"`

      - `boolean`

      - `"mixed"`

        - `"mixed"`

    - `readonly?: boolean`

    - `required?: boolean`

    - `roledescription?: string`

    - `selected?: boolean`

    - `value?: string | number`

      - `string`

      - `number`

    - `valuemax?: number`

    - `valuemin?: number`

    - `valuetext?: string`

### Example

```typescript
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const accessibilityTree = await client.browserRendering.accessibilityTree.create({
  account_id: 'account_id',
  url: 'https://www.example.com/',
});

console.log(accessibilityTree.accessibilityTree);
```

#### Response

```json
{
  "meta": {
    "headers": {
      "foo": "string"
    },
    "status": 0,
    "title": "title"
  },
  "result": {
    "accessibilityTree": {
      "role": "role",
      "autocomplete": "autocomplete",
      "checked": "mixed",
      "children": [
        {}
      ],
      "description": "description",
      "disabled": true,
      "expanded": true,
      "focused": true,
      "haspopup": "haspopup",
      "invalid": "invalid",
      "keyshortcuts": "keyshortcuts",
      "level": 0,
      "modal": true,
      "multiline": true,
      "multiselectable": true,
      "name": "name",
      "orientation": "orientation",
      "pressed": "mixed",
      "readonly": true,
      "required": true,
      "roledescription": "roledescription",
      "selected": true,
      "value": "string",
      "valuemax": 0,
      "valuemin": 0,
      "valuetext": "valuetext"
    }
  },
  "success": true,
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ]
}
```

## Domain Types

### Accessibility Tree Create Response

- `AccessibilityTreeCreateResponse`

  - `accessibilityTree: AccessibilityTree | null`

    Accessibility tree node

    - `role: string`

    - `autocomplete?: string`

    - `checked?: boolean | "mixed"`

      - `boolean`

      - `"mixed"`

        - `"mixed"`

    - `children?: Array<unknown>`

    - `description?: string`

    - `disabled?: boolean`

    - `expanded?: boolean`

    - `focused?: boolean`

    - `haspopup?: string`

    - `invalid?: string`

    - `keyshortcuts?: string`

    - `level?: number`

    - `modal?: boolean`

    - `multiline?: boolean`

    - `multiselectable?: boolean`

    - `name?: string`

    - `orientation?: string`

    - `pressed?: boolean | "mixed"`

      - `boolean`

      - `"mixed"`

        - `"mixed"`

    - `readonly?: boolean`

    - `required?: boolean`

    - `roledescription?: string`

    - `selected?: boolean`

    - `value?: string | number`

      - `string`

      - `number`

    - `valuemax?: number`

    - `valuemin?: number`

    - `valuetext?: string`