Logo of Lexmount
文档模板博客帮助中心
GitHub
Logo of LexmountLexmount Browser

开始使用

Lexmount 文档
控制台使用指南

Browser

Web Fetch

概览快速开始
All-in-One ExtractDump DOM
常见错误

Web Search

概览快速开始搜索接口

运行时

概览快速开始接口能力示例

帮助与计费

能力名词 FAQ
更新日志联系支持
接口参考

All-in-One Extract

POST /v1/extract 的完整请求与响应参考。

POST /v1/extract

当你希望一次请求完成页面抓取并直接拿到结构化结果时,使用这个接口。

鉴权说明

  • 外部调用时,请求需要同时带 X-API-Key 和 X-Project-Id
  • 在当前站点的 API 密钥设置 创建或复制 API key 与 project id
  • COM 项目使用 https://api.lexmount.com,CN 项目使用 https://api.lexmount.cn;凭据必须与 API 区域匹配

请求体

{
  "extract": {
    "url": "https://example.com"
  }
}

字段说明

字段类型必填说明
extractobject是提取请求主体
extract.urlstring否要抓取的页面 URL
extract.dom_idstring否已有 DOM 快照 ID
trace.include_stepsbool否传 true 时返回流程步骤
trace.include_raw_dombool否传 true 时返回原始 DOM

约束:

  • extract.url 和 extract.dom_id 至少传一个
  • 需要排查链路时再显式传 trace.include_steps=true

提取选项

字段类型说明
extract.options.engine_preferencestring默认 auto;可选引擎见 Dump DOM
extract.options.user_agentstring可选的抓取 User-Agent
{
  "extract": {
    "url": "https://example.com",
    "options": {
      "engine_preference": "chrome_cdp",
      "user_agent": "MyFetcher/1.0"
    }
  },
  "trace": { "include_steps": true }
}

extract.dom_id 存在时复用快照,不重新抓取 URL。建议只传返回的 dom_id,避免混入不相关 URL;更换引擎不能重新渲染已有快照,需要重新按 URL 抓取。

当前 /v1/extract 使用服务端控制的 30 秒提取时限;extract.options.timeout_ms 不会覆盖它,旧 workflow 字段也不会调整时限。公共网关另有超时限制。filter_scripts_styles 的清理行为属于 Dump DOM,不是本接口的输出开关。template_id 已不支持,模板自动匹配;不要依赖内部模板调试或强制生成字段。未知 JSON 字段会被拒绝。

最简示例

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请求关联 ID;同一个值也会出现在响应头 X-Request-ID
result成功时的结构化提取结果
metadata附加元信息,例如 dom_id、server_elapsed_ms
error失败时返回的错误对象
trace调试链路步骤;仅在 include_steps=true 时返回
raw_dom原始 DOM 内容;仅在 include_raw_dom=true 时返回

当你需要反馈问题、或者把客户端响应和服务端请求日志关联起来时,请保留 request_id。

result 中最常用的字段包括:

  • url
  • final_url
  • status_code
  • title
  • description
  • main_text
  • publish_time
  • author
  • language
  • links
  • images
  • engine
  • dom_id

复用已有 dom_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": {
      "dom_id": "123"
    }
  }'

开启 Trace

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

如果你需要查看抽取链路步骤,可以显式打开:

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"
    },
    "trace": {
      "include_steps": true
    }
  }'

返回 Raw DOM

raw_dom 默认不会返回。

只有在你确实需要把抓取到的 DOM 一并放进响应里时,才建议开启:

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"
    },
    "trace": {
      "include_raw_dom": true
    }
  }'
  • raw_dom 可能非常大,不适合常规线上调用

调试模式

如果既要看流程步骤,也要看原始 DOM,再同时打开两个字段:

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"
    },
    "trace": {
      "include_steps": true,
      "include_raw_dom": true
    }
  }'
  • trace 会显著增大响应体
  • raw_dom 可能非常大,不适合常规线上调用

常见失败与排查方式,见 Common Errors。

字段类型与可选输出

  • result.status_code 是目标页面状态,不是本次 API 的 HTTP 状态。
  • result.fetched_at 是时间字符串;publish_time 若有值也是时间字符串。
  • links 的元素是 { "text": "Example", "href": "https://example.com/" };images 的元素是 { "src": "https://example.com/image.png", "alt": "Example" }。
  • description、main_text、author、publish_time、language、links、images、debug 和 extra 均可能省略。遍历数组前先处理字段缺失的情况。
  • extra 可能包含 Open Graph、JSON-LD、DOM 概要等页面信息,内容随页面和提取方式变化。
  • metadata 可能包含 dom_id、不透明的 template_id 和 server_elapsed_ms。不要把其中的模板标识当成可传回的选项。
  • 即使请求了 raw_dom,没有可用快照内容时仍可能省略它。trace 中的具体步骤也可能随处理路径变化。

快照的复用范围和失效处理见 Dump DOM。

快速开始

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

Dump DOM

获取 HTML、检查渲染结果,并复用 DOM 快照。

目录

鉴权说明
请求体
字段说明
提取选项
最简示例
响应结构
复用已有 dom_id
开启 Trace
返回 Raw DOM
调试模式
字段类型与可选输出

问题没有解决?