DataEyesAI
Official SiteConsoleDocs Home
Getting StartedDeveloper ToolsAI Models APITerms & Policies
Official SiteConsoleDocs Home
Getting StartedDeveloper ToolsAI Models APITerms & Policies
  1. Search / Reader Product
  • Documentation
    • Getting Started
      • Welcome to DataEyesAI
      • Quickstart
      • API Keys and Authentication
      • Base URL and SDKs
      • Models, Groups, and Pricing
    • Developer Tool Integration
      • Claude Code
      • Claude Code for VS Code
      • Codex
      • OpenClaw
      • OpenCode
      • Cline
      • Gemini CLI
      • Grok CLI
      • n8n
      • AutoClaw
      • Other tools
      • Claude Code 400 troubleshooting
    • AI Models API
      • API Overview
      • Chat Completions
      • Responses
      • Messages (Claude)
      • Gemini (generateContent)
      • Embeddings
      • Image Models
        • Images
        • Gemini Image Generation
        • Grok Imagine Image
      • Midjourney format
        • Midjourney API Reference
        • Task query interface
        • Upload image
        • Get seed (Seed)
        • Submit Imagine task
        • Query tasks based on ID list
        • FaceSwap
        • Execute Action operation
        • /mj/submit/blend
        • Submit Describe task
        • Submit Modal
        • Refresh link
        • Edit image
        • Query task status by task ID
        • Get the seed of the task image
      • Video Model
        • FLUX Video Generation (flux-3-video)
        • Grok Video Generation
          • 00-Overview
          • 01-Text-to-Video
          • 02-Image-to-Video
          • 03-Reference-to-Video
          • 04-Video-Editing
          • 05-Video-Extension
        • Seedance Video Generation
          • 00-Overview
          • 01-Create-Video-Generation-Task
          • 02-Query-Video-Generation-Task
          • 03-Query-Video-Generation-Task-List
          • 04-Cancel-or-Delete-Task
          • Seedance Private Asset Library API Documentation
        • MiniMax-H3 Video Generation
          • 00-Overview
          • 01-Create-Video-Generation
          • 02-Create-Video-Regeneration
          • 03-Create-H3-Context-IR
          • 04-Query-Task
          • 05-List-Tasks
          • 06-Cancel-or-Delete-Task
        • Hailuo Video Generation
          • 00-Overview
          • 01-Text-to-Video-T2V
          • 02-Image-to-Video-I2V
          • 03-First-Last-Frame-FL2V
          • 04-Subject-Reference-S2V
          • 05-Query-Task-Status
          • 06-Video-Download
          • 99-Appendix-Camera-Movement-and-Webhooks
        • Jimeng Video Generation
          • 00-Overview
          • 01-3.0-Pro-Video-Generation
          • 02-720P-Text-to-Video
          • 03-720P-Image-to-Video-First-Frame
          • 04-720P-Image-to-Video-Start-End-Frame
          • 05-720P-Image-to-Video-Camera
          • 06-1080P-Text-to-Video
          • 07-1080P-Image-to-Video-First-Frame
          • 08-1080P-Image-to-Video-Start-End-Frame
          • 09-Error-Codes
        • Kling AI Video Generation
          • 00-Overview
          • 01-Text-to-Video
          • 02-Image-to-Video
          • 03-Omni-Video
          • 04-Multi-Image-to-Video
          • 05-Motion-Control
          • 06-Multi-Elements
          • 07-Video-Extension
          • 08-Lip-Sync
          • 09-Avatar
          • 10-Text-to-Audio
          • 11-Video-to-Audio
          • 12-TTS
          • 13-Custom-Voices
          • 14-Image-Recognition
          • 15-Element-Management
          • 16-Video-Effects
          • 17-Kling-4.0-Video-Generation
        • Vidu Video Generation
          • 00-Overview
          • 01-Text-to-Video
          • 02-Image-to-Video
          • 03-Reference-to-Video
          • 04-Start-End-Frame
          • 05-Multi-Frame
          • 06-Scene-Template
          • 07-Template-Story
          • 08-Query-Tasks
        • HappyHorse
          • HappyHorse Text-to-Video
          • HappyHorse Image-to-Video (First Frame)
          • HappyHorse Reference-to-Video
          • HappyHorse Video Editing
        • Wan Video Generation
          • 00-Overview.md
          • 01-Text-to-Video
          • 02-Image-to-Video
          • 03-Reference-to-Video
          • 04-Video-Editing
          • 05-First-Last-Frame-to-Video
          • 06-Motion-Transfer-and-Character-Swap
          • 07-Digital-Human-Video
          • 08-VACE-Video-Editing
          • 09-Query-Task
      • Audio API
        • Audio API
        • Gemini TTS API
        • Google DeepMind Lyria API
        • Elevenlabs Speech to Text API Reference
    • Search / Reader Product
      • Search & Reader
      • Web Search
      • Search and Read
      • Video Search
      • Web Reader
      • Document Parsing
      • Trending
      • Weather
      • All City ID
    • Advanced & System API
      • FAQ
      • System interface
        • API Key & Quota Query API
        • API Key Management API
      • API Reference​​
        • Error Codes
        • Rate Limits and Billing Rules
      • List models
        • Models
  • Terms & Policies
    • DataEyesAI API Terms of Service
    • DataEyesAI Legal Notice and Privacy Policy
    • DataEyesAI Paid Services Agreement
    • Automatic Renewal Service Rules
  1. Search / Reader Product

Web Reader

Pass a web page URL and get back the main content with ads and navigation removed, as LLM-friendly Markdown (or HTML), plus page metadata.
POST https://openapi.dataeyes.ai/v1/reader

Request parameters#

The request body is JSON.
ParameterTypeRequiredDescription
urlstringYesTarget page URL. Only http / https are supported
formatstringNoOutput format: markdown (default), html, or both
timeoutintegerNoRead timeout in seconds; must be at least 1
maxAgeintegerNoMaximum 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
noStoreintegerNo1 means this result is not written to the cache. Default 0
headersobjectNoRequest headers to send when fetching, such as Cookie or User-Agent
waitUntilstringNoPage load wait strategy: domcontentloaded, load, or networkidle. Use networkidle for dynamic pages
sanitizationstringNoContent cleaning mode: clean or raw
filterStrategystringNoContent filtering strategy: pruning or bm25
filterConfigobjectNoConfiguration for the bm25 strategy: userQuery (the question you care about), bm25Threshold (threshold), language (language)

Request examples#

cURL
Python

Response#

{
  "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"
}
FieldDescription
metadata.title / description / keywords / siteName / faviconPage metadata; empty if unavailable
metadata.statusCodeHTTP status code of the target page
metadata.cached1 means the result came from the cache; cachedAt is also returned
markdown / htmlPage content, depending on format; formats you did not request are empty strings

Billing#

Each successful request consumes 1 reader credit. Failures such as an unreachable page or a timeout are free. For error codes, see Error Codes.
Previous
Video Search
Next
Document Parsing