About this endpoint
What it does
Extracts the visible text from a webpage given its URL and returns it as a single string. You can optionally preserve paragraph breaks in the extracted text.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The webpage URL to extract text from. Must be a valid URI. |
| preserve_paragraphs | Boolean | No | Whether to preserve paragraph breaks in the extracted text. Default: false. |
Response
Returns a JSON object with a data string field containing the extracted visible text from the webpage. Success response: 200.
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| data | String | Yes | Extracted visible text from the webpage. |