About this endpoint
What it does
Converts the HTML content at a webpage URL into Markdown. The response returns the page title, the generated Markdown, the Markdown character count, and a boolean indicating whether readability processing succeeded.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | URL of the webpage to convert to Markdown. Must be a valid URI using http or https, with a maximum length of 2048 characters. |
Response
Returns a JSON object with four top-level fields: title as a string, markdown as a string, character_count as an integer, and readability_success as a boolean.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| title | String | No | The page title. |
| markdown | String | No | The generated Markdown content. |
| character_count | Integer | No | The number of characters in the generated Markdown. |
| readability_success | Boolean | No | Indicates whether readability processing succeeded. |