---
title: Get json.
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Browser Rendering](https://developers.cloudflare.com/api/resources/browser_rendering)
[Json](https://developers.cloudflare.com/api/resources/browser_rendering/subresources/json)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get json.
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`
##### P ath ParametersExpand Collapse
account\_id: string
Account ID.
[Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20account_id%20%3E%20(schema)>)
##### Q uery ParametersExpand Collapse
browser: optional "kitesurf"
Rendering backend. Set to `kitesurf` to use Kitesurf (beta).
[Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20browser%20%3E%20(schema)>)
cacheTTL: optional number
Cache TTL default is 5s. Set to 0 to disable.
maximum86400
minimum0
[Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20cacheTTL%20%3E%20(schema)>)
##### Body ParametersJSONExpand Collapse
body: object {url, actionTimeout, addScriptTag, 20 more } or object {html, actionTimeout, addScriptTag, 20 more }
One of the following:
object {url, actionTimeout, addScriptTag, 20 more }
url: string
Link to this property
actionTimeout: optional number
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: optional array of object {id, content, type, url }
Adds a script element into the page with the desired URL or content.
id: optional string
Link to this property
content: optional string
Link to this property
type: optional string
Link to this property
url: optional string
formaturi
Link to this property
Link to this property
addStyleTag: optional array of object {content, url }
Adds a <link rel="stylesheet"> tag into the page with the desired URL or a <style type="text/css"> tag with the content.
content: optional string
Link to this property
url: optional string
formaturi
Link to this property
Link to this property
allowRequestPattern: optional array of string
Only allow requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Reject rules are applied first.
Link to this property
allowResourceTypes: optional array of "document"or "stylesheet"or "image"or 15 more
Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first.
One of the following:
"document"
Link to this property
"stylesheet"
Link to this property
"image"
Link to this property
"media"
Link to this property
"font"
Link to this property
"script"
Link to this property
"texttrack"
Link to this property
"xhr"
Link to this property
"fetch"
Link to this property
"prefetch"
Link to this property
"eventsource"
Link to this property
"websocket"
Link to this property
"manifest"
Link to this property
"signedexchange"
Link to this property
"ping"
Link to this property
"cspviolationreport"
Link to this property
"preflight"
Link to this property
"other"
Link to this property
Link to this property
authenticate: optional object {password, username }
Provide credentials for HTTP authentication.
password: string
minLength1
Link to this property
username: string
minLength1
Link to this property
Link to this property
bestAttempt: optional boolean
Attempt to proceed when ‘awaited’ events fail or timeout.
Link to this property
cookies: optional array of object {name, value, domain, 11 more }
Check options.
name: string
Cookie name.
Link to this property
value: string
Link to this property
domain: optional string
Link to this property
expires: optional number
Link to this property
httpOnly: optional boolean
Link to this property
partitionKey: optional string
Link to this property
path: optional string
Link to this property
priority: optional "Low"or "Medium"or "High"
One of the following:
"Low"
Link to this property
"Medium"
Link to this property
"High"
Link to this property
Link to this property
sameParty: optional boolean
Link to this property
sameSite: optional "Strict"or "Lax"or "None"
One of the following:
"Strict"
Link to this property
"Lax"
Link to this property
"None"
Link to this property
Link to this property
secure: optional boolean
Link to this property
sourcePort: optional number
Link to this property
sourceScheme: optional "Unset"or "NonSecure"or "Secure"
One of the following:
"Unset"
Link to this property
"NonSecure"
Link to this property
"Secure"
Link to this property
Link to this property
url: optional string
Link to this property
Link to this property
custom\_ai: optional array of object {model, authorization }
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: optional string
Authorization token for the AI model: Bearer <token>. Not needed for workers-ai models.
Link to this property
Link to this property
emulateMediaType: optional string
Link to this property
gotoOptions: optional object {referer, referrerPolicy, timeout, waitUntil }
Check options.
referer: optional string
Link to this property
referrerPolicy: optional string
Link to this property
timeout: optional number
maximum60000
Link to this property
waitUntil: optional "load"or "domcontentloaded"or "networkidle0"or "networkidle2"or array of "load"or "domcontentloaded"or "networkidle0"or "networkidle2"
One of the following:
"load"or "domcontentloaded"or "networkidle0"or "networkidle2"
One of the following:
"load"
Link to this property
"domcontentloaded"
Link to this property
"networkidle0"
Link to this property
"networkidle2"
Link to this property
Link to this property
array of "load"or "domcontentloaded"or "networkidle0"or "networkidle2"
One of the following:
"load"
Link to this property
"domcontentloaded"
Link to this property
"networkidle0"
Link to this property
"networkidle2"
Link to this property
Link to this property
Link to this property
Link to this property
html: optional string
Link to this property
prompt: optional string
Link to this property
rejectRequestPattern: optional array of string
Block undesired requests that match the provided regex patterns, eg. ’/^.\*.(css)’.
Link to this property
rejectResourceTypes: optional array of "document"or "stylesheet"or "image"or 15 more
Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’.
One of the following:
"document"
Link to this property
"stylesheet"
Link to this property
"image"
Link to this property
"media"
Link to this property
"font"
Link to this property
"script"
Link to this property
"texttrack"
Link to this property
"xhr"
Link to this property
"fetch"
Link to this property
"prefetch"
Link to this property
"eventsource"
Link to this property
"websocket"
Link to this property
"manifest"
Link to this property
"signedexchange"
Link to this property
"ping"
Link to this property
"cspviolationreport"
Link to this property
"preflight"
Link to this property
"other"
Link to this property
Link to this property
response\_format: optional object {type, json\_schema }
type: string
Link to this property
json\_schema: optional map\[unknown]
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: optional map\[string]
Link to this property
setJavaScriptEnabled: optional boolean
Link to this property
userAgent: optional string
Link to this property
viewport: optional object {height, width, deviceScaleFactor, 3 more }
Check options.
height: number
Link to this property
width: number
Link to this property
deviceScaleFactor: optional number
Link to this property
hasTouch: optional boolean
Link to this property
isLandscape: optional boolean
Link to this property
isMobile: optional boolean
Link to this property
Link to this property
waitForSelector: optional object {selector, hidden, timeout, visible }
Wait for the selector to appear in page. Check options.
selector: string
Link to this property
hidden: optional true
Link to this property
timeout: optional number
maximum120000
Link to this property
visible: optional true
Link to this property
Link to this property
waitForTimeout: optional number
Waits for a specified timeout before continuing.
maximum120000
Link to this property
Link to this property
object {html, actionTimeout, addScriptTag, 20 more }
html: string
Link to this property
actionTimeout: optional number
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: optional array of object {id, content, type, url }
Adds a script element into the page with the desired URL or content.
id: optional string
Link to this property
content: optional string
Link to this property
type: optional string
Link to this property
url: optional string
formaturi
Link to this property
Link to this property
addStyleTag: optional array of object {content, url }
Adds a <link rel="stylesheet"> tag into the page with the desired URL or a <style type="text/css"> tag with the content.
content: optional string
Link to this property
url: optional string
formaturi
Link to this property
Link to this property
allowRequestPattern: optional array of string
Only allow requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Reject rules are applied first.
Link to this property
allowResourceTypes: optional array of "document"or "stylesheet"or "image"or 15 more
Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first.
One of the following:
"document"
Link to this property
"stylesheet"
Link to this property
"image"
Link to this property
"media"
Link to this property
"font"
Link to this property
"script"
Link to this property
"texttrack"
Link to this property
"xhr"
Link to this property
"fetch"
Link to this property
"prefetch"
Link to this property
"eventsource"
Link to this property
"websocket"
Link to this property
"manifest"
Link to this property
"signedexchange"
Link to this property
"ping"
Link to this property
"cspviolationreport"
Link to this property
"preflight"
Link to this property
"other"
Link to this property
Link to this property
authenticate: optional object {password, username }
Provide credentials for HTTP authentication.
password: string
minLength1
Link to this property
username: string
minLength1
Link to this property
Link to this property
bestAttempt: optional boolean
Attempt to proceed when ‘awaited’ events fail or timeout.
Link to this property
cookies: optional array of object {name, value, domain, 11 more }
Check options.
name: string
Cookie name.
Link to this property
value: string
Link to this property
domain: optional string
Link to this property
expires: optional number
Link to this property
httpOnly: optional boolean
Link to this property
partitionKey: optional string
Link to this property
path: optional string
Link to this property
priority: optional "Low"or "Medium"or "High"
One of the following:
"Low"
Link to this property
"Medium"
Link to this property
"High"
Link to this property
Link to this property
sameParty: optional boolean
Link to this property
sameSite: optional "Strict"or "Lax"or "None"
One of the following:
"Strict"
Link to this property
"Lax"
Link to this property
"None"
Link to this property
Link to this property
secure: optional boolean
Link to this property
sourcePort: optional number
Link to this property
sourceScheme: optional "Unset"or "NonSecure"or "Secure"
One of the following:
"Unset"
Link to this property
"NonSecure"
Link to this property
"Secure"
Link to this property
Link to this property
url: optional string
Link to this property
Link to this property
custom\_ai: optional array of object {model, authorization }
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: optional string
Authorization token for the AI model: Bearer <token>. Not needed for workers-ai models.
Link to this property
Link to this property
emulateMediaType: optional string
Link to this property
gotoOptions: optional object {referer, referrerPolicy, timeout, waitUntil }
Check options.
referer: optional string
Link to this property
referrerPolicy: optional string
Link to this property
timeout: optional number
maximum60000
Link to this property
waitUntil: optional "load"or "domcontentloaded"or "networkidle0"or "networkidle2"or array of "load"or "domcontentloaded"or "networkidle0"or "networkidle2"
One of the following:
"load"or "domcontentloaded"or "networkidle0"or "networkidle2"
One of the following:
"load"
Link to this property
"domcontentloaded"
Link to this property
"networkidle0"
Link to this property
"networkidle2"
Link to this property
Link to this property
array of "load"or "domcontentloaded"or "networkidle0"or "networkidle2"
One of the following:
"load"
Link to this property
"domcontentloaded"
Link to this property
"networkidle0"
Link to this property
"networkidle2"
Link to this property
Link to this property
Link to this property
Link to this property
prompt: optional string
Link to this property
rejectRequestPattern: optional array of string
Block undesired requests that match the provided regex patterns, eg. ’/^.\*.(css)’.
Link to this property
rejectResourceTypes: optional array of "document"or "stylesheet"or "image"or 15 more
Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’.
One of the following:
"document"
Link to this property
"stylesheet"
Link to this property
"image"
Link to this property
"media"
Link to this property
"font"
Link to this property
"script"
Link to this property
"texttrack"
Link to this property
"xhr"
Link to this property
"fetch"
Link to this property
"prefetch"
Link to this property
"eventsource"
Link to this property
"websocket"
Link to this property
"manifest"
Link to this property
"signedexchange"
Link to this property
"ping"
Link to this property
"cspviolationreport"
Link to this property
"preflight"
Link to this property
"other"
Link to this property
Link to this property
response\_format: optional object {type, json\_schema }
type: string
Link to this property
json\_schema: optional map\[unknown]
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: optional map\[string]
Link to this property
setJavaScriptEnabled: optional boolean
Link to this property
url: optional string
Link to this property
userAgent: optional string
Link to this property
viewport: optional object {height, width, deviceScaleFactor, 3 more }
Check options.
height: number
Link to this property
width: number
Link to this property
deviceScaleFactor: optional number
Link to this property
hasTouch: optional boolean
Link to this property
isLandscape: optional boolean
Link to this property
isMobile: optional boolean
Link to this property
Link to this property
waitForSelector: optional object {selector, hidden, timeout, visible }
Wait for the selector to appear in page. Check options.
selector: string
Link to this property
hidden: optional true
Link to this property
timeout: optional number
maximum120000
Link to this property
visible: optional true
Link to this property
Link to this property
waitForTimeout: optional number
Waits for a specified timeout before continuing.
maximum120000
Link to this property
Link to this property
[Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20body%20%3E%20(schema)>)
##### ReturnsExpand Collapse
meta: object {finalUrl, headers, redirectChain, 2 more }
finalUrl: optional string
URL that served the response, after any redirects the browser followed.
Link to this property
headers: optional map\[string]
Origin response headers, lowercased. Repeated headers are joined with a newline. Credential and transport-only headers that do not survive rendering are omitted.
Link to this property
redirectChain: optional array of object {headers, status, url }
HTTP redirects followed to reach finalUrl, oldest first. Omitted for direct navigation and for client-side redirects such as meta refresh. An empty array means redirects occurred but their intermediate responses could not be read.
headers: map\[string]
Redirect response headers, including location.
Link to this property
status: number
HTTP status of the redirect.
Link to this property
url: string
URL that returned the redirect.
Link to this property
Link to this property
status: optional number
HTTP status returned by the origin.
Link to this property
title: optional string
Page title.
Link to this property
[Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20meta>)
result: map\[unknown]
[Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: boolean
Response status.
[Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
errors: optional array of object {code, message }
code: number
Error code.
Link to this property
message: string
Error message.
Link to this property
[Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
### Get json.
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/browser-rendering/json \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{
"url": "url"
}'
```
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
}
```