開發者

截圖 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。

內容審核

每張截圖在保存與返回之前都會經過內容審核。被判定違規的內容不會保存:回應改為返回一張提示圖,title 置空、nsfw_blocked 為 true。具體判定閾值屬內部策略,不對外承諾。

nsfw_blocked含義
false正常截圖,image_url 為真實截圖產物。
true已攔截——image_url 為提示圖,title 置空,原圖不會保存。

回應

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",
    "nsfw_blocked": false
  }
}

錯誤碼

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。