Skip to main content
POST
同步截图

入门

基础 URL

请求示例

成功请求会返回 base64 格式的截图及元数据:
解码 image_base64 以获取原始 JPEG 或 PNG 字节。

渲染选项

render 对象控制浏览器在截图前如何加载页面。所有字段均为可选 — 省略时使用服务器默认值。

便捷字段

这些顶层字段是合并到 renderactions 的别名,用于向后兼容和简化请求: 使用扁平字段的示例:

资源选项

resources 对象控制浏览器在截图期间加载哪些资源类型。在视觉保真度允许的情况下,阻止重型资源可加快请求速度。

Legacy GET 端点

GET /v1/ 返回原始图像字节(JPEG 或 PNG)而非 JSON。参数以查询字符串传递:
支持的查询参数:urlapi_keysession_idfingerprintcapture_full_pagewidthheightdelaycss_injectionuser_agentexport_format

请求参数

String
必填
要捕获的目标 URL。必须是公开的 HTTP 或 HTTPS URL。对 localhost 和私有 IP 地址的请求会被 SSRF 防护阻止。
String
必填
您的唯一 API 密钥。
String
可选的会话标识符,用于在多个请求之间复用浏览器状态(Cookie、local storage)。
String
浏览器指纹预设。支持的值:desktop_en_usdesktop_ru_rumobile_en_us
Object
浏览器会话的渲染和截图选项。
String
何时认为导航完成。值:domcontentloadednetworkidle。默认值:domcontentloaded
Integer
等待页面加载的最长时间(毫秒)。默认值:60000。
Integer
页面加载事件之后、截图前的额外延迟(毫秒)。
Boolean
true 时忽略目标页面的 TLS 证书错误。
Boolean
true 时捕获整个可滚动页面。默认值:true
String
输出格式:jpegpng。默认值:jpeg
String
浏览器会话的自定义 User-Agent。
Object
包含像素单位 widthheight 的 viewport 大小。
Object
资源加载控制。
Array
要阻止的资源类型。支持的值:imagesfontsmedia
Array
截图前执行的浏览器操作有序列表。每个操作是带有 type 字段的对象。
String
必填
操作类型。支持的值:waitwait_forclicktypescrollinject_css
String
wait_forclicktype 操作的 CSS 选择器。
String
type 操作要输入的文本。
String
inject_css 操作的 CSS 字符串。
String
scroll 操作的滚动目标(例如 bottom)。
Integer
wait 操作的持续时间(毫秒)。
Array
导航前注入的 Cookie。每个 Cookie 对象需要 namevalue;可选字段:domainpath
Boolean
render.full_page 的便捷别名。
Integer
render.viewport.width 的便捷别名。
Integer
render.viewport.height 的便捷别名。
Integer
截图前延迟(秒)。映射到 render.post_load_wait_ms
String
actions 中尚未存在时,通过 inject_css 操作注入的 CSS。
String
render.screenshot_format 的便捷别名。值:jpegpng

响应参数

API 响应以通用轻量 JSON 格式 返回。
Boolean
截图是否成功完成。
String
Base64 编码的图像数据。解码以获取原始 JPEG 或 PNG 字节。
String
图像的 MIME 类型(image/jpegimage/png)。
Object
有关截图的元数据,包括耗时(毫秒)。
Object
okfalse 时的错误详情。