Skip to content

Web collection

Fetch public web pages and return Markdown or structured JSON.

Inputs

urlsRequired · url_list

Web URLs

Default:
output_formatOptional · select

Output format

Default: markdown · Allowed: markdown, json

Minimal call

estimate_collection
{
  "input": {
    "output_format": "markdown",
    "urls": [
      "https://example.com/"
    ]
  },
  "task_code": "raw_html_v1",
  "task_query": "获取 https://example.com/ 的网页内容"
}

Result and pagination

  • mode: none
  • 2 Credits per successful URL; estimated 5–90 seconds.

Only the fields listed below are part of the stable result contract.

PathTypeDescription
meta.request_idstringAsklear request identifier for tracing.
meta.api_namestringExecuted collection operation name.
meta.latency_msintegerCollection execution latency in milliseconds.
meta.credits_chargedintegerAsklear Credits settled for each successful URL in this task.
data.documentsarray<object>One result document per submitted URL.
data.documents[].urlstringNormalized submitted URL.
data.documents[].statusenumsucceeded or failed.
data.documents[].formatenummarkdown or json.
data.documents[].contentstringConverted Markdown content when format is markdown and status is succeeded.
data.documents[].elementsarray<object>Structured JSON elements when format is json and status is succeeded.
data.documents[].elements[].typestringElement type, such as a visible HTML tag.
data.documents[].elements[].textstringVisible text for the element.
data.documents[].elements[].metadataobjectBounded element metadata; currently includes the source tag.
data.documents[].error_codestringStable error code for a failed document; currently collection_failed.