Skip to content

docs: Remove parameters table from JSON endpoint documentation #21447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2025
Merged

docs: Remove parameters table from JSON endpoint documentation #21447

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions src/content/docs/browser-rendering/rest-api/json-endpoint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,6 @@ sidebar:

The `/json` endpoint extracts structured data from a webpage. You can specify the expected output using either a `prompt` or a `response_format` parameter which accepts a JSON schema. The endpoint returns the extracted data in JSON format.

## Parameters

| Parameter | Mandatory | Note |
| --------------- | --------- | ---------------------------------------------------------------------------- |
| URL | yes | The URL of the webpage to extract data from. |
| prompt | no | Must supply one of `prompt` or `response_format`. |
| response_format | no | Must supply one of `prompt` or `response_format`. May include a JSON schema. |

:::note[Note]

The `/json` endpoint leverages [Workers AI](/workers-ai/) for data extraction. Using this endpoint incurs usage on Workers AI, which you can monitor usage through the Workers AI Dashboard.
Expand Down