Skip to main content
POST
与抓取任务关联的浏览器会话进行交互
使用此端点可继续与由先前抓取初始化的同一浏览器状态进行交互。必须提供 codeprompt 之一,不能同时提供两者。 POST /v2/scrape/{jobId}/interact 负责整个生命周期:
  1. 如果此抓取任务尚未存在浏览器会话,Firecrawl 会在与原始抓取相同的页面状态下创建一个会话。
  2. 提供 code 时,Firecrawl 会在浏览器沙箱中运行它;提供 prompt 时,AI 代理会使用自然语言自动完成该任务。
  3. 后续在同一 jobId 上调用 POST /interact 时,会复用同一个实时浏览器状态。
完成后,调用 DELETE /v2/scrape/{jobId}/interact 以停止该会话。

路径参数

请求体

响应

示例请求 (代码)

示例响应 (代码)

示例请求 (Prompt)

示例响应 (Prompt)

错误代码

有关详细使用方式和示例,请参见 Interact 功能指南

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

路径参数

jobId
string<uuid>
必填

抓取任务 ID

请求体

application/json
code
string
必填

要在与抓取任务绑定的浏览器沙箱中执行的代码

Required string length: 1 - 100000
language
enum<string>
默认值:node

要执行的代码语言。JavaScript 使用 node,代理浏览器 CLI 命令使用 bash

可用选项:
python,
node,
bash
origin
string

用于执行遥测的可选来源标签

timeout
integer
默认值:30

执行超时时间(秒)

必填范围: 1 <= x <= 300

响应

代码执行成功

cdpUrl
string | null

浏览器会话的原始 Chrome DevTools Protocol (CDP) WebSocket URL。可使用它通过 Playwright、Puppeteer 或任何 CDP 客户端直接连接。

error
string | null

如果代码引发异常时的错误消息

exitCode
integer | null

执行进程的退出代码

interactiveLiveViewUrl
string | null

交互式实时视图 URL(观看者可以控制浏览器)

killed
boolean

进程是否因超时而被终止

liveViewUrl
string | null

浏览器会话的只读实时视图 URL

output
string | null

AI 代理的最终响应(仅在使用 prompt 时出现)

result
string | null

标准输出(stdout 的别名)

stderr
string | null

代码执行的标准错误输出

stdout
string | null

代码执行的标准输出

success
boolean