跳轉到主要內容
POST https://api.acedata.cloud/webextrator/render

鑑權

請求頭加入 Authorization: Bearer <你的 API Key>

請求參數

欄位類型必填預設說明
urlstring-要渲染的頁面 URL
user_agentstring系統預設自訂 User-Agent
timeoutnumber30000單次渲染逾時(毫秒),最大 120000
wait_untilstringload載入完成事件:load/domcontentloaded/networkidle
delaynumber0載入完成後再等待的時間(毫秒),最大 30000
wait_for_selectorstring-等待該 CSS 選擇器出現
block_resourcesstring[]-屏蔽資源類型:image/media/font/stylesheet
headersobject-額外 HTTP 頭
cookiesarray-Cookie 列表,元素形如 {name, value, domain, path}
callback_urlstring-非同步模式回調地址;提供則立即返回任務 ID,結果透過 POST 回調

同步回應(不帶 callback_url)

{
  "success": true,
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "trace_id": "550e8400-e29b-41d4-a716-446655440001",
  "started_at": "2026-05-02T10:30:00.123Z",
  "finished_at": "2026-05-02T10:30:05.456Z",
  "elapsed": 5.333,
  "data": {
    "kind": "render",
    "url": "https://example.com",
    "title": "Example Domain",
    "html": "<!doctype html>...",
    "text": "Example Domain ...",
    "markdown": "# Example Domain\n...",
    "screenshot": "data:image/png;base64,iVBORw0K...",
    "links": ["https://www.iana.org/domains/example"]
  }
}

非同步模式(帶 callback_url)

初始回應:
{
  "success": true,
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "trace_id": "550e8400-e29b-41d4-a716-446655440001",
  "started_at": "2026-05-02T10:30:00.123Z"
}
回應頭會包含 x-usage-exempt: true,表示這次同步握手不扣費。任務真正完成後,平台會向 callback_url 發送一次 POST,請求體即同步回應中的 data 欄位加上同樣的 task_id / trace_id / started_at / finished_at / elapsed 欄位。

錯誤回應

{
  "success": false,
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "trace_id": "550e8400-e29b-41d4-a716-446655440001",
  "started_at": "2026-05-02T10:30:00.123Z",
  "error": {
    "code": "timeout",
    "message": "page load timed out after 30000ms"
  }
}
錯誤碼:bad_request / forbidden / too_many_requests / not_found / api_error / timeout / unknown / busy

範例

curl -X POST https://api.acedata.cloud/webextrator/render \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "wait_until": "networkidle",
    "block_resources": ["image", "media", "font"]
  }'