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

介绍

文档总览
X (Twitter)

All-in-One Extract

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

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

请求体

{
  "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

最简示例

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://mp.weixin.qq.com/s/H8Nnk6HEKlwDREmxdjsXSg"}}'

响应结构

顶层响应通常包含:

字段说明
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。

目录

鉴权说明
请求体
字段说明
最简示例
响应结构
复用已有 dom_id
开启 Trace
返回 Raw DOM
调试模式