Logo of LexmountLexmount 文档
Logo of LexmountLexmount 文档
首页

介绍

文档总览
X (Twitter)

快速开始

发出第一个 WebFetch 请求,并理解默认返回行为。

使用 Lexmount WebFetch API,可以直接从公开网页中提取结构化内容,而不需要自己搭建抓取、渲染和提取链路。

最常用的起点,是 POST /v1/extract。

鉴权说明

  • 当前接口处于内测阶段
  • 外部调用时,请求需要同时带 X-API-Key 和 X-Project-Id
  • 在 https://browser.lexmount.cn/settings/api-keys 创建或复制 API key 与 project id
  • 海外访问使用 https://browser.lexmount.com/settings/api-keys,并把接口入口替换为 https://api.lexmount.com

第一个请求

API_KEY='<your-api-key>'
PROJECT_ID='<your-project-id>'

curl -sS -X POST https://api.lexmount.cn/v1/extract \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $API_KEY" \
  -H "X-Project-Id: $PROJECT_ID" \
  -d '{
    "extract": {
      "url": "https://example.com"
    }
  }'

典型响应:

{
  "request_id": "01964d0f-5f3a-7c3d-8a41-1234567890ab",
  "result": {
    "url": "https://example.com",
    "final_url": "https://example.com",
    "status_code": 200,
    "title": "Example Domain",
    "description": "Example Domain",
    "main_text": "Example Domain This domain is for use in illustrative examples in documents.",
    "engine": "http",
    "dom_id": "dom_123"
  },
  "metadata": {
    "dom_id": "dom_123",
    "server_elapsed_ms": 1234
  }
}

所有 JSON 响应还会带一个顶层 request_id。同一个值也会出现在响应头 X-Request-ID 里,方便和服务端日志、请求记录做关联排查。

你会拿到什么

POST /v1/extract 是一体化接口,内部会自动完成:

  • 页面抓取
  • 模板匹配
  • 必要时的后台模板生成
  • 最终结构化提取

result 里最常用的字段包括:

  • title
  • description
  • main_text
  • final_url
  • author
  • publish_time
  • links
  • images
  • engine
  • dom_id

顶层排查字段:

  • request_id

什么时候使用 Dump DOM

当你需要直接拿到抓取后的 HTML、检查页面渲染结果、或者希望复用某次抓取得到的 dom_id 时,使用 POST /v1/dom/dump。

curl -sS -X POST https://api.lexmount.cn/v1/dom/dump \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $API_KEY" \
  -H "X-Project-Id: $PROJECT_ID" \
  -d '{"url":"https://example.com"}' \
  | jq '{final_url, engine, dom_id, html_len:(.html|length)}'

可选调试字段

POST /v1/extract 默认不返回 trace 和 raw_dom。

  • 如果你需要查看抽取链路步骤,见 开启 Trace
  • 如果你需要在响应中拿到 raw_dom,见 返回 Raw DOM

下一步

  • 查看 All-in-One Extract 了解 /v1/extract 的完整请求和响应格式
  • 查看 Dump DOM 了解 /v1/dom/dump 的参数与复用方式
  • 查看 常见错误 了解常见错误和排查方式

目录

鉴权说明
第一个请求
你会拿到什么
什么时候使用 Dump DOM
可选调试字段
下一步