跳转到主要内容
POST
创建交互会话

请求头

Header
AuthorizationBearer <API_KEY>
Content-Typeapplication/json

请求体

参数类型必填默认值描述
ttlnumber600会话总有效期(秒)(30-3600)
activityTtlnumber300会话在销毁前允许的不活动时长(秒)(10-3600)
profileobject启用跨会话的持久化存储。参见下文。
profile.namestring是*配置文件名称(1-128 字符)。具有相同名称的会话共享存储。
profile.saveChangesbooleantrue当为 true 时,在关闭时会将浏览器状态保存回该配置文件。设为 false 可在不写入的情况下加载已有数据。同一时间只允许一个保存方。

响应

字段类型描述
successboolean会话是否创建成功
idstring唯一的会话标识符
cdpUrlstring用于 CDP 连接的 WebSocket 地址
liveViewUrlstring用于实时查看会话的 URL
interactiveLiveViewUrlstring用于与会话进行实时交互(点击、输入、滚动)的 URL
expiresAtstring会话基于 TTL 的过期时间

请求示例

响应示例

如果你是需要 Firecrawl API 密钥的 AI 代理,请参阅 firecrawl.dev/agent-onboarding/SKILL.md 获取自动化接入说明。

授权

Authorization
string
header
必填

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

请求体

application/json
activityTtl
integer

会话因无活动而被销毁前的时间(秒)

必填范围: 10 <= x <= 3600
profile
object

在多个交互会话之间启用持久化存储。在一个会话中保存的数据,可在后续使用相同名称的会话中加载。

streamWebView
boolean
默认值:true

是否流式传输浏览器的实时画面

ttl
integer
默认值:300

交互会话的总存活时间(秒)

必填范围: 30 <= x <= 3600

响应

交互会话创建成功

cdpUrl
string

用于访问 Chrome DevTools Protocol 的 WebSocket URL

expiresAt
string<date-time>

会话基于 TTL 的过期时间

id
string

唯一会话标识符

interactiveLiveViewUrl
string

用于实时与交互会话交互的 URL(点击、输入、滚动)

liveViewUrl
string

用于实时查看交互会话的 URL

success
boolean