メインコンテンツへスキップ
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-非同期モードのコールバック URL;指定すると即座にタスク 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"]
  }'