Get markdown.

client.browserRendering.markdown.create(, ?): MarkdownCreateResponse

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

Gets markdown of a webpage from provided URL or HTML. Control page loading with gotoOptions and waitFor* options.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Browser Rendering Write

ParametersExpand Collapse

MarkdownCreateParams = Variant0 | Variant1

MarkdownCreateParamsBase

Variant0 extends MarkdownCreateParamsBase

Variant1 extends MarkdownCreateParamsBase

ReturnsExpand Collapse

MarkdownCreateResponse = string

Markdown content.

Get markdown.

import Cloudflare from 'cloudflare';

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

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

console.log(markdown);

{
  "success": true,
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": "result"
}

{
  "errors": [
    {
      "code": 2001,
      "message": "Rate limit exceeded"
    }
  ],
  "success": false
}

Returns Examples

{
  "success": true,
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": "result"
}

{
  "errors": [
    {
      "code": 2001,
      "message": "Rate limit exceeded"
    }
  ],
  "success": false
}