--- title: Get markdown. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Browser Rendering](https://developers.cloudflare.com/api/go/resources/browser_rendering) [Markdown](https://developers.cloudflare.com/api/go/resources/browser_rendering/subresources/markdown) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # 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. Link to this property URL param.Field\[string] Body param Link to this property

Browser param.Field\[MarkdownNewParamsVariant0Browser]Optional Query param: Rendering backend. Set to kitesurf to use Kitesurf (beta).

const MarkdownNewParamsVariant0BrowserKitesurf MarkdownNewParamsVariant0Browser = "kitesurf" Link to this property

Link to this property CacheTTL param.Field\[float64]Optional Query param: Cache TTL default is 5s. Set to 0 to disable. maximum86400 minimum0 Link to this property 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 Link to this property

AddScriptTag param.Field\[\[]MarkdownNewParamsVariant0AddScriptTag]Optional Body param: Adds a script element into the page with the desired URL or content.

ID stringOptional Link to this property Content stringOptional Link to this property Type stringOptional Link to this property URL stringOptional formaturi Link to this property

Link to this property

AddStyleTag param.Field\[\[]MarkdownNewParamsVariant0AddStyleTag]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 Link to this property URL stringOptional formaturi Link to this property

Link to this property AllowRequestPattern param.Field\[\[]string]Optional Body param: Only allow requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Reject rules are applied first. Link to this property

AllowResourceTypes param.Field\[\[]MarkdownNewParamsVariant0AllowResourceType]Optional Body param: Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first.

const MarkdownNewParamsVariant0AllowResourceTypeDocument MarkdownNewParamsVariant0AllowResourceType = "document" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeStylesheet MarkdownNewParamsVariant0AllowResourceType = "stylesheet" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeImage MarkdownNewParamsVariant0AllowResourceType = "image" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeMedia MarkdownNewParamsVariant0AllowResourceType = "media" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeFont MarkdownNewParamsVariant0AllowResourceType = "font" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeScript MarkdownNewParamsVariant0AllowResourceType = "script" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeTexttrack MarkdownNewParamsVariant0AllowResourceType = "texttrack" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeXHR MarkdownNewParamsVariant0AllowResourceType = "xhr" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeFetch MarkdownNewParamsVariant0AllowResourceType = "fetch" Link to this property const MarkdownNewParamsVariant0AllowResourceTypePrefetch MarkdownNewParamsVariant0AllowResourceType = "prefetch" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeEventsource MarkdownNewParamsVariant0AllowResourceType = "eventsource" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeWebsocket MarkdownNewParamsVariant0AllowResourceType = "websocket" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeManifest MarkdownNewParamsVariant0AllowResourceType = "manifest" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeSignedexchange MarkdownNewParamsVariant0AllowResourceType = "signedexchange" Link to this property const MarkdownNewParamsVariant0AllowResourceTypePing MarkdownNewParamsVariant0AllowResourceType = "ping" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeCspviolationreport MarkdownNewParamsVariant0AllowResourceType = "cspviolationreport" Link to this property const MarkdownNewParamsVariant0AllowResourceTypePreflight MarkdownNewParamsVariant0AllowResourceType = "preflight" Link to this property const MarkdownNewParamsVariant0AllowResourceTypeOther MarkdownNewParamsVariant0AllowResourceType = "other" Link to this property

Link to this property

Authenticate param.Field\[MarkdownNewParamsVariant0Authenticate]Optional Body param: Provide credentials for HTTP authentication.

Password string minLength1 Link to this property Username string minLength1 Link to this property

Link to this property BestAttempt param.Field\[bool]Optional Body param: Attempt to proceed when ‘awaited’ events fail or timeout. Link to this property

Cookies param.Field\[\[]MarkdownNewParamsVariant0Cookie]Optional Body param: Check options.

Name string Cookie name. Link to this property Value string Link to this property Domain stringOptional Link to this property Expires float64Optional Link to this property HTTPOnly boolOptional Link to this property PartitionKey stringOptional Link to this property Path stringOptional Link to this property

Priority MarkdownNewParamsVariant0CookiesPriorityOptional

One of the following: const MarkdownNewParamsVariant0CookiesPriorityLow MarkdownNewParamsVariant0CookiesPriority = "Low" Link to this property const MarkdownNewParamsVariant0CookiesPriorityMedium MarkdownNewParamsVariant0CookiesPriority = "Medium" Link to this property const MarkdownNewParamsVariant0CookiesPriorityHigh MarkdownNewParamsVariant0CookiesPriority = "High" Link to this property

Link to this property SameParty boolOptional Link to this property

SameSite MarkdownNewParamsVariant0CookiesSameSiteOptional

One of the following: const MarkdownNewParamsVariant0CookiesSameSiteStrict MarkdownNewParamsVariant0CookiesSameSite = "Strict" Link to this property const MarkdownNewParamsVariant0CookiesSameSiteLax MarkdownNewParamsVariant0CookiesSameSite = "Lax" Link to this property const MarkdownNewParamsVariant0CookiesSameSiteNone MarkdownNewParamsVariant0CookiesSameSite = "None" Link to this property

Link to this property Secure boolOptional Link to this property SourcePort float64Optional Link to this property

SourceScheme MarkdownNewParamsVariant0CookiesSourceSchemeOptional

One of the following: const MarkdownNewParamsVariant0CookiesSourceSchemeUnset MarkdownNewParamsVariant0CookiesSourceScheme = "Unset" Link to this property const MarkdownNewParamsVariant0CookiesSourceSchemeNonSecure MarkdownNewParamsVariant0CookiesSourceScheme = "NonSecure" Link to this property const MarkdownNewParamsVariant0CookiesSourceSchemeSecure MarkdownNewParamsVariant0CookiesSourceScheme = "Secure" Link to this property

Link to this property URL stringOptional Link to this property

Link to this property EmulateMediaType param.Field\[string]Optional Body param Link to this property

GotoOptions param.Field\[MarkdownNewParamsVariant0GotoOptions]Optional Body param: Check options.

Referer stringOptional Link to this property ReferrerPolicy stringOptional Link to this property Timeout float64Optional maximum60000 Link to this property

WaitUntil MarkdownNewParamsVariant0GotoOptionsWaitUntilUnionOptional

One of the following:

MarkdownNewParamsVariant0GotoOptionsWaitUntilString

One of the following: const MarkdownNewParamsVariant0GotoOptionsWaitUntilStringLoad MarkdownNewParamsVariant0GotoOptionsWaitUntilString = "load" Link to this property const MarkdownNewParamsVariant0GotoOptionsWaitUntilStringDomcontentloaded MarkdownNewParamsVariant0GotoOptionsWaitUntilString = "domcontentloaded" Link to this property const MarkdownNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle0 MarkdownNewParamsVariant0GotoOptionsWaitUntilString = "networkidle0" Link to this property const MarkdownNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle2 MarkdownNewParamsVariant0GotoOptionsWaitUntilString = "networkidle2" Link to this property

Link to this property

MarkdownNewParamsVariant0GotoOptionsWaitUntilArray

One of the following: const MarkdownNewParamsVariant0GotoOptionsWaitUntilArrayLoad MarkdownNewParamsVariant0GotoOptionsWaitUntilArray = "load" Link to this property const MarkdownNewParamsVariant0GotoOptionsWaitUntilArrayDomcontentloaded MarkdownNewParamsVariant0GotoOptionsWaitUntilArray = "domcontentloaded" Link to this property const MarkdownNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle0 MarkdownNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle0" Link to this property const MarkdownNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle2 MarkdownNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle2" Link to this property

Link to this property

Link to this property HTML param.Field\[string]Optional Body param Link to this property RejectRequestPattern param.Field\[\[]string]Optional Body param: Block undesired requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Link to this property

RejectResourceTypes param.Field\[\[]MarkdownNewParamsVariant0RejectResourceType]Optional Body param: Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’.

const MarkdownNewParamsVariant0RejectResourceTypeDocument MarkdownNewParamsVariant0RejectResourceType = "document" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeStylesheet MarkdownNewParamsVariant0RejectResourceType = "stylesheet" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeImage MarkdownNewParamsVariant0RejectResourceType = "image" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeMedia MarkdownNewParamsVariant0RejectResourceType = "media" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeFont MarkdownNewParamsVariant0RejectResourceType = "font" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeScript MarkdownNewParamsVariant0RejectResourceType = "script" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeTexttrack MarkdownNewParamsVariant0RejectResourceType = "texttrack" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeXHR MarkdownNewParamsVariant0RejectResourceType = "xhr" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeFetch MarkdownNewParamsVariant0RejectResourceType = "fetch" Link to this property const MarkdownNewParamsVariant0RejectResourceTypePrefetch MarkdownNewParamsVariant0RejectResourceType = "prefetch" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeEventsource MarkdownNewParamsVariant0RejectResourceType = "eventsource" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeWebsocket MarkdownNewParamsVariant0RejectResourceType = "websocket" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeManifest MarkdownNewParamsVariant0RejectResourceType = "manifest" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeSignedexchange MarkdownNewParamsVariant0RejectResourceType = "signedexchange" Link to this property const MarkdownNewParamsVariant0RejectResourceTypePing MarkdownNewParamsVariant0RejectResourceType = "ping" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeCspviolationreport MarkdownNewParamsVariant0RejectResourceType = "cspviolationreport" Link to this property const MarkdownNewParamsVariant0RejectResourceTypePreflight MarkdownNewParamsVariant0RejectResourceType = "preflight" Link to this property const MarkdownNewParamsVariant0RejectResourceTypeOther MarkdownNewParamsVariant0RejectResourceType = "other" Link to this property

Link to this property SetExtraHTTPHeaders param.Field\[map\[string, string]]Optional Body param Link to this property SetJavaScriptEnabled param.Field\[bool]Optional Body param Link to this property UserAgent param.Field\[string]Optional Body param Link to this property

Viewport param.Field\[MarkdownNewParamsVariant0Viewport]Optional Body param: Check options.

Height float64 Link to this property Width float64 Link to this property DeviceScaleFactor float64Optional Link to this property HasTouch boolOptional Link to this property IsLandscape boolOptional Link to this property IsMobile boolOptional Link to this property

Link to this property

WaitForSelector param.Field\[MarkdownNewParamsVariant0WaitForSelector]Optional Body param: Wait for the selector to appear in page. Check options.

Selector string Link to this property Hidden MarkdownNewParamsVariant0WaitForSelectorHiddenOptional Link to this property Timeout float64Optional maximum120000 Link to this property Visible MarkdownNewParamsVariant0WaitForSelectorVisibleOptional Link to this property

Link to this property WaitForTimeout param.Field\[float64]Optional Body param: Waits for a specified timeout before continuing. maximum120000 Link to this property

[Link to this property](<#(resource)%20browser_rendering.markdown%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse type MarkdownNewResponseEnvelopeResult string Markdown content. Prefixed with YAML frontmatter (e.g. `title`) when the page provides that metadata. [Link to this property](<#(resource)%20browser_rendering.markdown%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Get markdown. Go HTTPTypeScriptPythonGoTerraform ``` 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"), Body: browser_rendering.MarkdownNewParamsBodyObject{ URL: cloudflare.F("https://www.example.com/"), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", markdown) } ``` 200 example 429 example ``` { "meta": { "finalUrl": "finalUrl", "headers": { "foo": "string" }, "redirectChain": [ { "headers": { "foo": "string" }, "status": 0, "url": "url" } ], "status": 0, "title": "title" }, "success": true, "errors": [ { "code": 0, "message": "message" } ], "result": "result" } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ``` ##### Returns Examples 200 example 429 example ``` { "meta": { "finalUrl": "finalUrl", "headers": { "foo": "string" }, "redirectChain": [ { "headers": { "foo": "string" }, "status": 0, "url": "url" } ], "status": 0, "title": "title" }, "success": true, "errors": [ { "code": 0, "message": "message" } ], "result": "result" } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ```