--- title: Get json. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Browser Rendering](https://developers.cloudflare.com/api/go/resources/browser_rendering) [Json](https://developers.cloudflare.com/api/go/resources/browser_rendering/subresources/json) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get json. client.BrowserRendering.Json.New(ctx, params) (\*[JsonNewResponse](), error) POST/accounts/{account\_id}/browser-rendering/json 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. ##### 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 JsonNewParams 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\[JsonNewParamsVariant0Browser]Optional Query param: Rendering backend. Set to kitesurf to use Kitesurf (beta). const JsonNewParamsVariant0BrowserKitesurf JsonNewParamsVariant0Browser = "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\[\[]JsonNewParamsVariant0AddScriptTag]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\[\[]JsonNewParamsVariant0AddStyleTag]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\[\[]JsonNewParamsVariant0AllowResourceType]Optional Body param: Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first. const JsonNewParamsVariant0AllowResourceTypeDocument JsonNewParamsVariant0AllowResourceType = "document" Link to this property const JsonNewParamsVariant0AllowResourceTypeStylesheet JsonNewParamsVariant0AllowResourceType = "stylesheet" Link to this property const JsonNewParamsVariant0AllowResourceTypeImage JsonNewParamsVariant0AllowResourceType = "image" Link to this property const JsonNewParamsVariant0AllowResourceTypeMedia JsonNewParamsVariant0AllowResourceType = "media" Link to this property const JsonNewParamsVariant0AllowResourceTypeFont JsonNewParamsVariant0AllowResourceType = "font" Link to this property const JsonNewParamsVariant0AllowResourceTypeScript JsonNewParamsVariant0AllowResourceType = "script" Link to this property const JsonNewParamsVariant0AllowResourceTypeTexttrack JsonNewParamsVariant0AllowResourceType = "texttrack" Link to this property const JsonNewParamsVariant0AllowResourceTypeXHR JsonNewParamsVariant0AllowResourceType = "xhr" Link to this property const JsonNewParamsVariant0AllowResourceTypeFetch JsonNewParamsVariant0AllowResourceType = "fetch" Link to this property const JsonNewParamsVariant0AllowResourceTypePrefetch JsonNewParamsVariant0AllowResourceType = "prefetch" Link to this property const JsonNewParamsVariant0AllowResourceTypeEventsource JsonNewParamsVariant0AllowResourceType = "eventsource" Link to this property const JsonNewParamsVariant0AllowResourceTypeWebsocket JsonNewParamsVariant0AllowResourceType = "websocket" Link to this property const JsonNewParamsVariant0AllowResourceTypeManifest JsonNewParamsVariant0AllowResourceType = "manifest" Link to this property const JsonNewParamsVariant0AllowResourceTypeSignedexchange JsonNewParamsVariant0AllowResourceType = "signedexchange" Link to this property const JsonNewParamsVariant0AllowResourceTypePing JsonNewParamsVariant0AllowResourceType = "ping" Link to this property const JsonNewParamsVariant0AllowResourceTypeCspviolationreport JsonNewParamsVariant0AllowResourceType = "cspviolationreport" Link to this property const JsonNewParamsVariant0AllowResourceTypePreflight JsonNewParamsVariant0AllowResourceType = "preflight" Link to this property const JsonNewParamsVariant0AllowResourceTypeOther JsonNewParamsVariant0AllowResourceType = "other" Link to this property
Link to this property
Authenticate param.Field\[JsonNewParamsVariant0Authenticate]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\[\[]JsonNewParamsVariant0Cookie]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 JsonNewParamsVariant0CookiesPriorityOptional One of the following: const JsonNewParamsVariant0CookiesPriorityLow JsonNewParamsVariant0CookiesPriority = "Low" Link to this property const JsonNewParamsVariant0CookiesPriorityMedium JsonNewParamsVariant0CookiesPriority = "Medium" Link to this property const JsonNewParamsVariant0CookiesPriorityHigh JsonNewParamsVariant0CookiesPriority = "High" Link to this property
Link to this property SameParty boolOptional Link to this property
SameSite JsonNewParamsVariant0CookiesSameSiteOptional One of the following: const JsonNewParamsVariant0CookiesSameSiteStrict JsonNewParamsVariant0CookiesSameSite = "Strict" Link to this property const JsonNewParamsVariant0CookiesSameSiteLax JsonNewParamsVariant0CookiesSameSite = "Lax" Link to this property const JsonNewParamsVariant0CookiesSameSiteNone JsonNewParamsVariant0CookiesSameSite = "None" Link to this property
Link to this property Secure boolOptional Link to this property SourcePort float64Optional Link to this property
SourceScheme JsonNewParamsVariant0CookiesSourceSchemeOptional One of the following: const JsonNewParamsVariant0CookiesSourceSchemeUnset JsonNewParamsVariant0CookiesSourceScheme = "Unset" Link to this property const JsonNewParamsVariant0CookiesSourceSchemeNonSecure JsonNewParamsVariant0CookiesSourceScheme = "NonSecure" Link to this property const JsonNewParamsVariant0CookiesSourceSchemeSecure JsonNewParamsVariant0CookiesSourceScheme = "Secure" Link to this property
Link to this property URL stringOptional Link to this property
Link to this property
CustomAI param.Field\[\[]JsonNewParamsVariant0CustomAI]Optional Body param: 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. Model string 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. Link to this property Authorization stringOptional Authorization token for the AI model: Bearer <token>. Not needed for workers-ai models. Link to this property
Link to this property EmulateMediaType param.Field\[string]Optional Body param Link to this property
GotoOptions param.Field\[JsonNewParamsVariant0GotoOptions]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 JsonNewParamsVariant0GotoOptionsWaitUntilUnionOptional One of the following:
JsonNewParamsVariant0GotoOptionsWaitUntilString One of the following: const JsonNewParamsVariant0GotoOptionsWaitUntilStringLoad JsonNewParamsVariant0GotoOptionsWaitUntilString = "load" Link to this property const JsonNewParamsVariant0GotoOptionsWaitUntilStringDomcontentloaded JsonNewParamsVariant0GotoOptionsWaitUntilString = "domcontentloaded" Link to this property const JsonNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle0 JsonNewParamsVariant0GotoOptionsWaitUntilString = "networkidle0" Link to this property const JsonNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle2 JsonNewParamsVariant0GotoOptionsWaitUntilString = "networkidle2" Link to this property
Link to this property
JsonNewParamsVariant0GotoOptionsWaitUntilArray One of the following: const JsonNewParamsVariant0GotoOptionsWaitUntilArrayLoad JsonNewParamsVariant0GotoOptionsWaitUntilArray = "load" Link to this property const JsonNewParamsVariant0GotoOptionsWaitUntilArrayDomcontentloaded JsonNewParamsVariant0GotoOptionsWaitUntilArray = "domcontentloaded" Link to this property const JsonNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle0 JsonNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle0" Link to this property const JsonNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle2 JsonNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle2" Link to this property
Link to this property
Link to this property
Link to this property HTML param.Field\[string]Optional Body param Link to this property Prompt 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\[\[]JsonNewParamsVariant0RejectResourceType]Optional Body param: Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’. const JsonNewParamsVariant0RejectResourceTypeDocument JsonNewParamsVariant0RejectResourceType = "document" Link to this property const JsonNewParamsVariant0RejectResourceTypeStylesheet JsonNewParamsVariant0RejectResourceType = "stylesheet" Link to this property const JsonNewParamsVariant0RejectResourceTypeImage JsonNewParamsVariant0RejectResourceType = "image" Link to this property const JsonNewParamsVariant0RejectResourceTypeMedia JsonNewParamsVariant0RejectResourceType = "media" Link to this property const JsonNewParamsVariant0RejectResourceTypeFont JsonNewParamsVariant0RejectResourceType = "font" Link to this property const JsonNewParamsVariant0RejectResourceTypeScript JsonNewParamsVariant0RejectResourceType = "script" Link to this property const JsonNewParamsVariant0RejectResourceTypeTexttrack JsonNewParamsVariant0RejectResourceType = "texttrack" Link to this property const JsonNewParamsVariant0RejectResourceTypeXHR JsonNewParamsVariant0RejectResourceType = "xhr" Link to this property const JsonNewParamsVariant0RejectResourceTypeFetch JsonNewParamsVariant0RejectResourceType = "fetch" Link to this property const JsonNewParamsVariant0RejectResourceTypePrefetch JsonNewParamsVariant0RejectResourceType = "prefetch" Link to this property const JsonNewParamsVariant0RejectResourceTypeEventsource JsonNewParamsVariant0RejectResourceType = "eventsource" Link to this property const JsonNewParamsVariant0RejectResourceTypeWebsocket JsonNewParamsVariant0RejectResourceType = "websocket" Link to this property const JsonNewParamsVariant0RejectResourceTypeManifest JsonNewParamsVariant0RejectResourceType = "manifest" Link to this property const JsonNewParamsVariant0RejectResourceTypeSignedexchange JsonNewParamsVariant0RejectResourceType = "signedexchange" Link to this property const JsonNewParamsVariant0RejectResourceTypePing JsonNewParamsVariant0RejectResourceType = "ping" Link to this property const JsonNewParamsVariant0RejectResourceTypeCspviolationreport JsonNewParamsVariant0RejectResourceType = "cspviolationreport" Link to this property const JsonNewParamsVariant0RejectResourceTypePreflight JsonNewParamsVariant0RejectResourceType = "preflight" Link to this property const JsonNewParamsVariant0RejectResourceTypeOther JsonNewParamsVariant0RejectResourceType = "other" Link to this property
Link to this property
ResponseFormat param.Field\[JsonNewParamsVariant0ResponseFormat]Optional Body param Type string Link to this property JsonSchema map\[string, unknown]Optional Schema for the response format. More information here: https://developers.cloudflare.com/workers-ai/json-mode/ 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\[JsonNewParamsVariant0Viewport]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\[JsonNewParamsVariant0WaitForSelector]Optional Body param: Wait for the selector to appear in page. Check options. Selector string Link to this property Hidden JsonNewParamsVariant0WaitForSelectorHiddenOptional Link to this property Timeout float64Optional maximum120000 Link to this property Visible JsonNewParamsVariant0WaitForSelectorVisibleOptional 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.json%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse type JsonNewResponse map\[string, unknown] [Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(model)%20JsonNewResponse%20%3E%20(schema)>) ### Get json. 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"), ) json, err := client.BrowserRendering.Json.New(context.TODO(), browser_rendering.JsonNewParams{ AccountID: cloudflare.F("account_id"), Body: browser_rendering.JsonNewParamsBodyObject{ URL: cloudflare.F("https://www.example.com/"), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", json) } ``` 200 example 429 example ``` { "meta": { "finalUrl": "finalUrl", "headers": { "foo": "string" }, "redirectChain": [ { "headers": { "foo": "string" }, "status": 0, "url": "url" } ], "status": 0, "title": "title" }, "result": { "foo": {} }, "success": true, "errors": [ { "code": 0, "message": "message" } ] } ``` ``` { "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" }, "result": { "foo": {} }, "success": true, "errors": [ { "code": 0, "message": "message" } ] } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ```