---
title: "Web Reader"
method: POST
path: "/paas/v4/reader"
tags: ["Tools API"]
---

# Web Reader

`POST /paas/v4/reader`

Reads and parses the content of the specified URL. Supports selectable return formats, cache control, image retention, and summary options.

## Request body

- ReaderRequest
  - `url` string, required — The URL to retrieve
  - `timeout` integer — Request timeout in seconds. Default is 20
  - `no_cache` boolean — Whether to disable caching (true/false). Default is false
  - `return_format` string — Return format (e.g., markdown, text). Default is markdown
  - `retain_images` boolean — Whether to retain images (true/false). Default is true
  - `no_gfm` boolean — Whether to disable GitHub Flavored Markdown (true/false). Default is false
  - `keep_img_data_url` boolean — Whether to keep image data URLs (true/false). Default is false
  - `with_images_summary` boolean — Whether to include image summary (true/false). Default is false
  - `with_links_summary` boolean — Whether to include links summary (true/false). Default is false

## Response `200`

Processing successful

- ReaderResponse
  - `id` string — Task ID
  - `created` integer — Request creation time as a Unix timestamp in seconds
  - `request_id` string — Client-provided unique identifier to distinguish requests. If not provided, the platform will generate one.
  - `model` string — Model code
  - `reader_result` object — Web reading result
    - `content` string — Main content parsed from the page (body, images, links, etc.)
    - `description` string — Brief description of the page
    - `title` string — Page title
    - `url` string — Original page URL
    - `external` object — External resources referenced by the page
      - `stylesheet` object — Collection of external stylesheets
    - `metadata` object — Page metadata
      - `keywords` string — Page keywords
      - `viewport` string — Viewport settings
      - `description` string — Meta description
      - `format-detection` string — Format detection settings, e.g., `telephone=no`

## Other responses

- `default` — The request has failed.

---

[API](https://skmtc.net/z/apis/z-ai-api.md) · [All operations](https://skmtc.net/z/apis/z-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/z/z-ai-api/revisions/62622aa47d10/schema)