创建浏览器会话

在沙盒环境中启动一个新的云浏览器会话。

POST /browser

创建浏览器会话

cURL

curl --request POST \
  --url https://api.firecrawl.dev/v2/browser \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ttl": 300,
  "activityTtl": 1805,
  "streamWebView": true,
  "profile": {
    "name": "<string>",
    "saveChanges": true
  }
}
'

200

{
  "success": true,
  "id": "<string>",
  "cdpUrl": "<string>",
  "liveViewUrl": "<string>",
  "interactiveLiveViewUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

​

请求头

Header	值
Authorization	Bearer <API_KEY>
Content-Type	application/json

​

请求体

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

​

响应

字段	类型	描述
success	boolean	会话是否创建成功
id	string	唯一的会话标识符
cdpUrl	string	用于 CDP 连接的 WebSocket 地址
liveViewUrl	string	用于实时查看会话的 URL
interactiveLiveViewUrl	string	用于与会话进行实时交互（点击、输入、滚动）的 URL
expiresAt	string	会话基于 TTL 的过期时间

​

请求示例

curl -X POST "https://api.firecrawl.dev/v2/browser" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ttl": 120
  }'

​

响应示例

{
  "success": true,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "cdpUrl": "wss://cdp-proxy.firecrawl.dev/cdp/550e8400-e29b-41d4-a716-446655440000",
  "liveViewUrl": "https://liveview.firecrawl.dev/550e8400-e29b-41d4-a716-446655440000",
  "interactiveLiveViewUrl": "https://liveview.firecrawl.dev/550e8400-e29b-41d4-a716-446655440000?interactive=true"
}

授权

Authorization · string · header · 必填

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

请求体

application/json

ttl · integer · 默认值: 300

浏览器会话的最大存活时长（秒）

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

activityTtl · integer

会话在空闲被销毁前的超时时长（秒）

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

streamWebView · boolean · 默认值: true

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

profile · object

在会话之间启用持久化存储。在一个会话中保存的数据，之后在使用相同名称的会话中可以重新加载。

Show child attributes

响应

200

application/json

浏览器会话创建成功

success · boolean

id · string

会话的唯一标识符

cdpUrl · string

用于访问 Chrome DevTools Protocol 的 WebSocket 地址

liveViewUrl · string

用于实时查看浏览会话的 URL

interactiveLiveViewUrl · string

用于实时与浏览器会话交互的 URL（点击、输入、滚动）

expiresAt · string<date-time>

会话按 TTL 计算的过期时间