Get markdown.

client.BrowserRendering.Markdown.New(ctx, params) (*string, error)

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

params MarkdownNewParams

AccountID param.Field[string]

Path param: Account ID.

CacheTTL param.Field[float64]Optional

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

maximum86400

minimum0

ActionTimeout param.Field[float64]Optional

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.

maximum120000

AddScriptTag param.Field[[]MarkdownNewParamsAddScriptTag]Optional

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

ID stringOptional

Content stringOptional

Type stringOptional

URL stringOptional

formaturi

AddStyleTag param.Field[[]MarkdownNewParamsAddStyleTag]Optional

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 stringOptional

URL stringOptional

formaturi

AllowRequestPattern param.Field[[]string]Optional

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

AllowResourceTypes param.Field[[]MarkdownNewParamsAllowResourceType]Optional

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

const MarkdownNewParamsAllowResourceTypeDocument MarkdownNewParamsAllowResourceType = "document"

const MarkdownNewParamsAllowResourceTypeStylesheet MarkdownNewParamsAllowResourceType = "stylesheet"

const MarkdownNewParamsAllowResourceTypeImage MarkdownNewParamsAllowResourceType = "image"

const MarkdownNewParamsAllowResourceTypeMedia MarkdownNewParamsAllowResourceType = "media"

const MarkdownNewParamsAllowResourceTypeFont MarkdownNewParamsAllowResourceType = "font"

const MarkdownNewParamsAllowResourceTypeScript MarkdownNewParamsAllowResourceType = "script"

const MarkdownNewParamsAllowResourceTypeTexttrack MarkdownNewParamsAllowResourceType = "texttrack"

const MarkdownNewParamsAllowResourceTypeXHR MarkdownNewParamsAllowResourceType = "xhr"

const MarkdownNewParamsAllowResourceTypeFetch MarkdownNewParamsAllowResourceType = "fetch"

const MarkdownNewParamsAllowResourceTypePrefetch MarkdownNewParamsAllowResourceType = "prefetch"

const MarkdownNewParamsAllowResourceTypeEventsource MarkdownNewParamsAllowResourceType = "eventsource"

const MarkdownNewParamsAllowResourceTypeWebsocket MarkdownNewParamsAllowResourceType = "websocket"

const MarkdownNewParamsAllowResourceTypeManifest MarkdownNewParamsAllowResourceType = "manifest"

const MarkdownNewParamsAllowResourceTypeSignedexchange MarkdownNewParamsAllowResourceType = "signedexchange"

const MarkdownNewParamsAllowResourceTypePing MarkdownNewParamsAllowResourceType = "ping"

const MarkdownNewParamsAllowResourceTypeCspviolationreport MarkdownNewParamsAllowResourceType = "cspviolationreport"

const MarkdownNewParamsAllowResourceTypePreflight MarkdownNewParamsAllowResourceType = "preflight"

const MarkdownNewParamsAllowResourceTypeOther MarkdownNewParamsAllowResourceType = "other"

Authenticate param.Field[MarkdownNewParamsAuthenticate]Optional

Body param: Provide credentials for HTTP authentication.

Password string

minLength1

Username string

minLength1

BestAttempt param.Field[bool]Optional

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

Cookies param.Field[[]MarkdownNewParamsCookie]Optional

Body param: Check options.

Name string

Cookie name.

Value string

Domain stringOptional

Expires float64Optional

HTTPOnly boolOptional

PartitionKey stringOptional

Path stringOptional

Priority MarkdownNewParamsCookiesPriorityOptional

One of the following:

const MarkdownNewParamsCookiesPriorityLow MarkdownNewParamsCookiesPriority = "Low"

const MarkdownNewParamsCookiesPriorityMedium MarkdownNewParamsCookiesPriority = "Medium"

const MarkdownNewParamsCookiesPriorityHigh MarkdownNewParamsCookiesPriority = "High"

SameParty boolOptional

SameSite MarkdownNewParamsCookiesSameSiteOptional

One of the following:

const MarkdownNewParamsCookiesSameSiteStrict MarkdownNewParamsCookiesSameSite = "Strict"

const MarkdownNewParamsCookiesSameSiteLax MarkdownNewParamsCookiesSameSite = "Lax"

const MarkdownNewParamsCookiesSameSiteNone MarkdownNewParamsCookiesSameSite = "None"

Secure boolOptional

SourcePort float64Optional

SourceScheme MarkdownNewParamsCookiesSourceSchemeOptional

One of the following:

const MarkdownNewParamsCookiesSourceSchemeUnset MarkdownNewParamsCookiesSourceScheme = "Unset"

const MarkdownNewParamsCookiesSourceSchemeNonSecure MarkdownNewParamsCookiesSourceScheme = "NonSecure"

const MarkdownNewParamsCookiesSourceSchemeSecure MarkdownNewParamsCookiesSourceScheme = "Secure"

URL stringOptional

EmulateMediaType param.Field[string]Optional

Body param

GotoOptions param.Field[MarkdownNewParamsGotoOptions]Optional

Body param: Check options.

Referer stringOptional

ReferrerPolicy stringOptional

Timeout float64Optional

maximum60000

WaitUntil MarkdownNewParamsGotoOptionsWaitUntilUnionOptional

One of the following:

type MarkdownNewParamsGotoOptionsWaitUntilString string

One of the following:

const MarkdownNewParamsGotoOptionsWaitUntilStringLoad MarkdownNewParamsGotoOptionsWaitUntilString = "load"

const MarkdownNewParamsGotoOptionsWaitUntilStringDomcontentloaded MarkdownNewParamsGotoOptionsWaitUntilString = "domcontentloaded"

const MarkdownNewParamsGotoOptionsWaitUntilStringNetworkidle0 MarkdownNewParamsGotoOptionsWaitUntilString = "networkidle0"

const MarkdownNewParamsGotoOptionsWaitUntilStringNetworkidle2 MarkdownNewParamsGotoOptionsWaitUntilString = "networkidle2"

type MarkdownNewParamsGotoOptionsWaitUntilArray []MarkdownNewParamsGotoOptionsWaitUntilArray

One of the following:

const MarkdownNewParamsGotoOptionsWaitUntilArrayItemLoad MarkdownNewParamsGotoOptionsWaitUntilArrayItem = "load"

const MarkdownNewParamsGotoOptionsWaitUntilArrayItemDomcontentloaded MarkdownNewParamsGotoOptionsWaitUntilArrayItem = "domcontentloaded"

const MarkdownNewParamsGotoOptionsWaitUntilArrayItemNetworkidle0 MarkdownNewParamsGotoOptionsWaitUntilArrayItem = "networkidle0"

const MarkdownNewParamsGotoOptionsWaitUntilArrayItemNetworkidle2 MarkdownNewParamsGotoOptionsWaitUntilArrayItem = "networkidle2"

HTML param.Field[string]Optional

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

minLength1

RejectRequestPattern param.Field[[]string]Optional

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

RejectResourceTypes param.Field[[]MarkdownNewParamsRejectResourceType]Optional

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

const MarkdownNewParamsRejectResourceTypeDocument MarkdownNewParamsRejectResourceType = "document"

const MarkdownNewParamsRejectResourceTypeStylesheet MarkdownNewParamsRejectResourceType = "stylesheet"

const MarkdownNewParamsRejectResourceTypeImage MarkdownNewParamsRejectResourceType = "image"

const MarkdownNewParamsRejectResourceTypeMedia MarkdownNewParamsRejectResourceType = "media"

const MarkdownNewParamsRejectResourceTypeFont MarkdownNewParamsRejectResourceType = "font"

const MarkdownNewParamsRejectResourceTypeScript MarkdownNewParamsRejectResourceType = "script"

const MarkdownNewParamsRejectResourceTypeTexttrack MarkdownNewParamsRejectResourceType = "texttrack"

const MarkdownNewParamsRejectResourceTypeXHR MarkdownNewParamsRejectResourceType = "xhr"

const MarkdownNewParamsRejectResourceTypeFetch MarkdownNewParamsRejectResourceType = "fetch"

const MarkdownNewParamsRejectResourceTypePrefetch MarkdownNewParamsRejectResourceType = "prefetch"

const MarkdownNewParamsRejectResourceTypeEventsource MarkdownNewParamsRejectResourceType = "eventsource"

const MarkdownNewParamsRejectResourceTypeWebsocket MarkdownNewParamsRejectResourceType = "websocket"

const MarkdownNewParamsRejectResourceTypeManifest MarkdownNewParamsRejectResourceType = "manifest"

const MarkdownNewParamsRejectResourceTypeSignedexchange MarkdownNewParamsRejectResourceType = "signedexchange"

const MarkdownNewParamsRejectResourceTypePing MarkdownNewParamsRejectResourceType = "ping"

const MarkdownNewParamsRejectResourceTypeCspviolationreport MarkdownNewParamsRejectResourceType = "cspviolationreport"

const MarkdownNewParamsRejectResourceTypePreflight MarkdownNewParamsRejectResourceType = "preflight"

const MarkdownNewParamsRejectResourceTypeOther MarkdownNewParamsRejectResourceType = "other"

SetExtraHTTPHeaders param.Field[map[string, string]]Optional

Body param

SetJavaScriptEnabled param.Field[bool]Optional

Body param

URL param.Field[string]Optional

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

formaturi

UserAgent param.Field[string]Optional

Body param

Viewport param.Field[MarkdownNewParamsViewport]Optional

Body param: Check options.

Height float64

Width float64

DeviceScaleFactor float64Optional

HasTouch boolOptional

IsLandscape boolOptional

IsMobile boolOptional

WaitForSelector param.Field[MarkdownNewParamsWaitForSelector]Optional

Body param: Wait for the selector to appear in page. Check options.

Selector string

Hidden MarkdownNewParamsWaitForSelectorHiddenOptional

Timeout float64Optional

maximum120000

Visible MarkdownNewParamsWaitForSelectorVisibleOptional

WaitForTimeout param.Field[float64]Optional

Body param: Waits for a specified timeout before continuing.

maximum120000

ReturnsExpand Collapse

type MarkdownNewResponseEnvelopeResult string

Markdown content.

Get markdown.

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/browser_rendering"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  markdown, err := client.BrowserRendering.Markdown.New(context.TODO(), browser_rendering.MarkdownNewParams{
    AccountID: cloudflare.F("account_id"),
    URL: cloudflare.F("https://www.example.com/"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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
}