开发者

截图 API

一次 POST 把公网网址变成截图:选好认证方式、发 JSON 请求、拿到短时效图片链接。

快速开始

在账号页签发一把 Key,然后带 Bearer 认证调用端点:

# API Key 认证——Key 在账号页签发
curl -X POST https://websitescreenshot.litelake.com/api/open/screenshot \
  -H "Authorization: Bearer lws_dev_…" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","format":"png","device":"pc","full_page":false}'

认证方式

三条路、同一份契约:请求体与响应完全一致,只有端点与每日额度不同。

匿名试用 — POST /api/public/screenshot

无需账号。每 IP 每天 10 张,同一时间只能进行 1 张截图。

登录档 — POST /api/user/screenshot

登录后在工具页提交即走会话认证,计入免费档:每天 1000 张。

API Key — POST /api/open/screenshot

Bearer 认证(Authorization: Bearer lws_…),开放全参数面。内部档 Key 不限额;响应带 X-RateLimit-* 头,429 响应带 Retry-After。

参数

参数类型说明
urlstring必填。以 http:// 或 https:// 开头的完整公网网址,长度不超过 2048。
format"png" | "jpg"图片格式,默认 png。
device"pc" | "mobile"设备预设:pc = 1920×1080 桌面 UA;mobile = 390×844 移动 UA。默认 pc。
full_pageboolean截取整页可滚动内容而非首屏,默认 false。

响应

HTTP 200 信封结构:data.image_url 为 1 小时有效的签名下载链接;cached=true 表示命中 1 天缓存、直接返回同一次截图。

{
  "code": 200, "message": "ok",
  "data": {
    "image_url": "https://…(presigned GET, valid 1h)",
    "cached": false,
    "final_url": "https://example.com/",
    "title": "Example Domain",
    "width": 1920, "height": 1080,
    "task_id": "…",
    "cache_expires_at": "2026-10-12T08:00:00Z"
  }
}

错误码

public/open 端点返回真实 HTTP 状态码 + body.code 4 位业务码;429 响应带 Retry-After 头;open 通道成功响应带 X-RateLimit-Limit / Remaining / Reset 头。

业务码HTTP含义
4001400url_invalid——不是以 http/https 开头的完整网址。
4002400ssrf_blocked——目标是内网/保留地址,只支持公网站点。
4003400page_load_failed——站点打不开或拒绝截图(含重定向过多)。
4004400invalid_options——参数超出支持范围。
4005400empty_output——截图产物为空。
5041504page_timeout——目标站点响应超时(产品层上限 75 秒)。
4290429分钟级限流,等 Retry-After 窗口过后重试。
4291429当日配额用尽;Retry-After 指向下一个 00:00(UTC)。
4292429并发上限——同一主体已有在途截图。
5001503截图后端繁忙或不可达,稍后重新提交。
5004503服务依赖的存储暂时不可用(为保证正确性直接拒绝),稍后重试。
5002500截图产物转存存储失败,重试通常即可恢复。

获取 API Key

登录后在账号页自助签发,最多 3 把有效 Key;明文只在签发时展示一次。 打开账号页

限制说明

  • 截图结果缓存 1 天——窗口内相同请求直接返回已存图片,不再重新截图。
  • 匿名档同一时间只能进行 1 张截图(否则 HTTP 429、业务码 4292)。
  • 全页模式会渲染整页可滚动内容;超长页面可能较慢——可改用首屏或 JPG。
  • 单张截图约 75 秒超时;反复超时请稍后重试,或关闭全页、改用 JPG。