About this endpoint
What it does
Extracts the visible text from a webpage and returns it as an array of lines. The preserve_paragraphs query parameter controls whether the extracted text is split into discrete lines or kept in paragraph form.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | Webpage URL to extract text from. Format: URI. |
| preserve_paragraphs | Boolean | No | If true, preserves paragraphs instead of splitting the extracted text into discrete lines. Default: false. |
Response
Returns a JSON object with a data string array field containing the extracted visible text from the webpage. Each array item is a line of text, unless preserve_paragraphs is true.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | String Array | Yes | Extracted text split into discrete lines, unless preserve_paragraphs is true. |