# Webpage Readable Content Extraction
Extract clean, readable article content from webpages or HTML.
## API Overview
- **HTTP Protocol:** HTTPS
- **HTTP Method:** POST
- **HTTP Endpoint:** https://api.gugudata.io/v1/websitetools/readability
- **Response Type:** application/json; charset=utf-8
- **DEMO Endpoint:** https://api.gugudata.io/v1/websitetools/readability/demo
- **Live Demo:** https://gugudata.io/demo/readability
- **Postman:** https://www.postman.com/gugudata/gugudata-io
- **LLM Page:** https://gugudata.io/details/readability/llm
- **Raw Markdown:** https://gugudata.io/details/readability/llm.md
## Remote MCP
- **MCP Endpoint:** https://mcp.gugudata.io/mcp
- **MCP Guide:** https://gugudata.io/mcp/
- **Authorization:** OAuth authorization opens in the browser; do not paste appkeys into MCP clients.
- **Tool Scope:** MCP clients receive GuGuData API tools available to the authorized account.
## Data & API Features
- Readable article HTML: Extract the main article with useful text formatting.
- Plain-text output: Use extracted text for indexing and content workflows.
- Article metadata: Read the title, author and language when available.
- Page or HTML input: Submit a public page URL or raw HTML.
- Reduced page clutter: Remove navigation and surrounding page elements.
- Content workflows: Prepare articles for search, review and summarization.
## API Request Parameters
| Name | Type | Is Required | Default Value | Remark |
| --- | --- | --- | --- | --- |
| appkey | string | true | YOUR_APPKEY | API key used to authenticate the request. |
| html | string | false | YOUR_VALUE | Raw HTML content. Supply either `html` or `url`. |
| url | string | false | YOUR_VALUE | Target webpage URL. Supply either `url` or `html`. |
## API Response Parameters
| Name | Type | Remark |
| --- | --- | --- |
| DataStatus.RequestParameter | string | Privacy-safe summary of the normalized request. |
| DataStatus.StatusCode | integer | Application-level status code. |
| DataStatus.StatusDescription | string | Human-readable application status message. |
| DataStatus.ResponseDateTime | string | Time at which the response was generated. |
| DataStatus.DataTotalCount | integer | Number of matching or returned records for this request. |
| Data.Title | string | Article title. |
| Data.Byline | string | Article author. |
| Data.Dir | string | Article text direction. |
| Data.Lang | string | Article language. |
| Data.Content | string | Article content. |
| Data.TextContent | string | Article content (without HTML tags, divided by paragraphs). |
| Data.Length | integer | Article length. |
| Data.Excerpt | string | Article excerpt. |
| Data.SiteName | string | Website name. |
| Data.PublishedTime | array<string> | Article publication time. |
## API Response Status Codes
| Status Code | Explanation of Status Code | Remarks |
| --- | --- | --- |
| 200 | Request processed successfully. | Some endpoints expose a separate application-level status field in the response body, such as `dataStatus.statusCode`. |
| 400 | Invalid request parameters or request format. | Check required fields, data types, and request body format. |
| 401 | Missing or unknown application key. | Provide a valid `appkey` with the request. |
| 403 | The application key is recognized but access is not allowed. | The key may be expired, inactive, or not permitted for the requested API. |
| 429 | Request rate or trial usage limit exceeded. | Reduce request frequency and retry with backoff. If a trial allowance is exhausted, check Trial Keys for remaining requests and subscribe to continue. |
| 500 | Internal service error. | Retry later or contact support if the error persists. |
| 503 | Upstream service unavailable. | Retry later; the requested upstream dependency is temporarily unavailable. |
## cURL Example
```bash
curl --location 'https://api.gugudata.io/v1/websitetools/readability?appkey=YOUR_APPKEY' --request POST --header 'Content-Type: application/json' --data '{
"html": "YOUR_VALUE",
"url": "YOUR_VALUE"
}'
```