POST https://openapi.dataeyes.ai/v1/reader| Parameter | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Target page URL. Only http / https are supported |
format | string | No | Output format: markdown (default), html, or both |
timeout | integer | No | Read timeout in seconds; must be at least 1 |
maxAge | integer | No | Maximum acceptable cache age in seconds. 0 disables the cache and fetches live; if omitted, a cached result up to 2 days old may be returned |
noStore | integer | No | 1 means this result is not written to the cache. Default 0 |
headers | object | No | Request headers to send when fetching, such as Cookie or User-Agent |
waitUntil | string | No | Page load wait strategy: domcontentloaded, load, or networkidle. Use networkidle for dynamic pages |
sanitization | string | No | Content cleaning mode: clean or raw |
filterStrategy | string | No | Content filtering strategy: pruning or bm25 |
filterConfig | object | No | Configuration for the bm25 strategy: userQuery (the question you care about), bm25Threshold (threshold), language (language) |
{
"code": 0,
"data": {
"metadata": {
"url": "https://example.com",
"title": "Example Domain",
"description": "",
"keywords": "",
"siteName": "",
"favicon": "https://example.com/favicon.ico",
"statusCode": 200,
"contentType": "text/html; charset=utf-8",
"cached": 0
},
"html": "",
"markdown": "This domain is for use in documentation examples without needing permission. ..."
},
"message": "success"
}| Field | Description |
|---|---|
metadata.title / description / keywords / siteName / favicon | Page metadata; empty if unavailable |
metadata.statusCode | HTTP status code of the target page |
metadata.cached | 1 means the result came from the cache; cachedAt is also returned |
markdown / html | Page content, depending on format; formats you did not request are empty strings |