Brapi-json-endpoint

[daisyfaithauma]

Summary

Screenshots (optional)

Documentation checklist

• The documentation style guide has been adhered to.
• If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
• Files which have changed name or location have been allocated redirects.

[hyperlint-ai]

Identified issues

• Vale Style Guide - (Terms-error) Use 'URL' instead of 'url'.

Proposed fix

Suggested change

	| url | yes | The URL of the webpage to extract data from. |
	| URL | yes | The URL of the webpage to extract data from. |

I capitalized 'url' to 'URL' as it is not within any restricted formatting and should follow the style guide.

[hyperlint-ai]

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

---

PR Change Summary

Added a new JSON endpoint documentation for capturing webpage data.

• Introduced a new /json endpoint for extracting structured data from webpages.
• Documented parameters for the endpoint including url, prompt, and response_format.
• Provided examples of usage with different combinations of parameters.
• Outlined potential use-cases for the new endpoint.

Added Files

• src/content/docs/browser-rendering/rest-api/json-endpoint.mdx

---

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.