Read a web page
read_pageRead-onlyIdempotent
Get the main content of a web page as clean Markdown, without ads, navigation, pop-ups or comments, plus its title, author, date and word count. Use this whenever you need to read, quote or summarise a page. It is cheaper than fetching and cleaning the raw HTML yourself. Link addresses are left out to save tokens: set include_links to true when you need the URLs. A page longer than 60000 characters is cut at a paragraph and the result says so: set max_chars to read more. Reads public pages only. Counts as one document on the API key's plan.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The full address of the web page, starting with https://. | |
| max_chars | No | Most characters of Markdown to return (60000 is about 15,000 tokens). A longer page is cut at a paragraph or heading, and the result says so and gives the full length. Call again with a larger value, up to 400000, to read more; each call counts as a document. | |
| include_links | No | Keep the page's link addresses in the Markdown, as [text](url). Off by default, because the addresses can be most of the output. Turn on when you need to cite or follow a link. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The address the content came from. | |
| date | No | The publication date, when the page gives one. | |
| site | No | The site's name. | |
| image | No | The page's lead image, when it has one. | |
| title | Yes | The page's title. | |
| author | No | The author, when the page names one. | |
| excerpt | No | A one or two sentence summary of the page. | |
| markdown | Yes | The main content of the page as Markdown, cut at max_chars when it is longer. | |
| truncated | Yes | True when the Markdown was cut short at max_chars. | |
| word_count | Yes | Words in the main content. | |
| total_chars | Yes | Length in characters of the page's whole Markdown, cut or not. |