Skip to content
Firecrawl Docs
Firecrawl Docs
Interact エンドポイント

スクレイピングしたページを操作する

POST/scrape/{jobId}/interact

スクレイピングジョブに紐付けられたブラウザセッションで、コードまたは AI プロンプトを実行します。

このエンドポイントを使用すると、以前のスクレイピングから初期化されたのと同じブラウザ状態で、引き続き操作できます。code または prompt のいずれか一方を指定する必要があります。両方は指定できません。

POST /v2/scrape/{jobId}/interact はライフサイクル全体を処理します。

  1. このスクレイピングジョブ用のブラウザセッションがまだ存在しない場合、Firecrawl は元のスクレイピングと同じページ状態でブラウザセッションを作成します。
  2. code が指定されている場合、Firecrawl はそれをブラウザサンドボックスで実行します。prompt が指定されている場合は、AI エージェントが自然言語を使ってタスクを自動化します。
  3. 同じ jobId に対する後続の POST /interact 呼び出しでは、同じライブのブラウザ状態が再利用されます。

完了したら、DELETE /v2/scrape/{jobId}/interact を呼び出してセッションを停止します。

パラメータ型必須説明
jobIdstring (UUID)はいスクレイピングのレスポンス内の data.metadata.scrapeId に含まれるスクレイピングジョブ ID

リクエストボディ

パラメータ型必須デフォルト説明
codestringいいえ—ブラウザサンドボックスで実行するコード (1～100,000文字) 。promptが設定されていない場合は必須です。
promptstringいいえ—AIエージェント向けの自然言語タスク (1～10,000文字) 。codeが設定されていない場合は必須です。
languagestringいいえ"node""python"、"node"、"bash" のいずれか。codeを使用する場合にのみ使われます。
timeoutnumberいいえ30実行タイムアウト (秒) (1～300) 。
originstringいいえ—テレメトリに使用される任意のオリジンラベル。
フィールド型説明
successboolean実行がエラーなく完了したかどうか
cdpUrlstringブラウザセッション用の Chrome DevTools Protocol (CDP) の生の WebSocket URL。Playwright、Puppeteer、または任意の CDP クライアントで直接接続できます
liveViewUrlstringブラウザセッション用の読み取り専用ライブビューURL
interactiveLiveViewUrlstringインタラクティブ ライブビューURL (閲覧者がブラウザを操作可能)
outputstringAIエージェントの最終レスポンス (prompt を使用した場合のみ存在)
stdoutstringコード実行の標準出力
resultstring戻り値 — Node.js では最後の式の値、prompt では最終ページのスナップショット
stderrstring標準エラー出力
exitCodenumber実行の終了コード (0 = 成功)
killedbooleanタイムアウトにより実行が終了したかどうか
errorstringエラーメッセージ (失敗時のみ存在)
curl -X POST "https://api.firecrawl.dev/v2/scrape/550e8400-e29b-41d4-a716-446655440000/interact" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "const title = await page.title(); JSON.stringify({ title });",
    "language": "node",
    "timeout": 30
  }'
{
  "success": true,
  "cdpUrl": "wss://browser.firecrawl.dev/...",
  "liveViewUrl": "https://liveview.firecrawl.dev/...",
  "interactiveLiveViewUrl": "https://liveview.firecrawl.dev/...",
  "stdout": "",
  "result": "{\"title\":\"Example Domain\"}",
  "stderr": "",
  "exitCode": 0,
  "killed": false
}
curl -X POST "https://api.firecrawl.dev/v2/scrape/550e8400-e29b-41d4-a716-446655440000/interact" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Find the pricing section and tell me the price of the Pro plan",
    "timeout": 60
  }'
{
  "success": true,
  "cdpUrl": "wss://browser.firecrawl.dev/...",
  "liveViewUrl": "https://liveview.firecrawl.dev/...",
  "interactiveLiveViewUrl": "https://liveview.firecrawl.dev/...",
  "output": "The Pro plan costs $49/month and includes unlimited scrapes, priority support, and custom integrations.",
  "stdout": "...",
  "result": "...",
  "stderr": "",
  "exitCode": 0,
  "killed": false
}
ステータス説明
402ブラウザセッションのクレジットが不足しています
403スクレイピングジョブは別のチームに属しています
404スクレイピングジョブが見つかりません
409リプレイコンテキストを利用できません — スクレイピングを再実行してもう一度お試しください
410ブラウザセッションはすでに破棄されています
429同時ブラウザセッション数の上限に達しました
502ブラウザサービスまたはAIエージェントの実行に失敗しました
503ブラウザ機能が設定されていません (セルフホスト環境のみ)

詳細な使用方法と例については、Interact機能ガイドを参照してください。

Was this page helpful?Suggest editsRaise issue
PreviousInteractセッションの削除Nextインタラクションを停止

On this page

パスパラメータリクエストボディレスポンスリクエスト例 (コード)レスポンス例 (コード)リクエスト例 (Prompt)レスポンス例 (Prompt)エラーコード