Zz
Tools API

Web Reader

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

post/paas/v4/reader

Request

  • Base URL
    https://api.z.ai/api
  • URL
    https://api.z.ai/api/paas/v4/reader
  • Auth
    HTTP bearer

Request body

urlstring required

The URL to retrieve

timeoutinteger

Request timeout in seconds. Default is 20

no_cacheboolean

Whether to disable caching (true/false). Default is false

return_formatstring

Return format (e.g., markdown, text). Default is markdown

retain_imagesboolean

Whether to retain images (true/false). Default is true

no_gfmboolean

Whether to disable GitHub Flavored Markdown (true/false). Default is false

keep_img_data_urlboolean

Whether to keep image data URLs (true/false). Default is false

with_images_summaryboolean

Whether to include image summary (true/false). Default is false

with_links_summaryboolean

Whether to include links summary (true/false). Default is false

Response

Processing successful

idstring

Task ID

createdinteger

Request creation time as a Unix timestamp in seconds

request_idstring

Client-provided unique identifier to distinguish requests. If not provided, the platform will generate one.

modelstring

Model code

Changes

No operation changes recorded.