跳转到主要内容
POST
/
browser
创建浏览器会话
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
}
'
{
  "success": true,
  "id": "<string>",
  "cdpUrl": "<string>",
  "liveViewUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

请求头

Header
AuthorizationBearer <API_KEY>
Content-Typeapplication/json

请求体

参数类型必填默认值描述
ttlnumber300会话总有效期(秒)(30-3600)
activityTtlnumber60会话在销毁前允许的不活动时长(秒)(10-3600)

响应

字段类型描述
successboolean会话是否创建成功
idstring唯一的会话标识符
cdpUrlstring用于 CDP 连接的 WebSocket 地址
liveViewUrlstring用于实时查看会话的 URL
expiresAtstring会话基于 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"
}

授权

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

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

响应

浏览器会话创建成功

success
boolean
id
string

会话的唯一标识符

cdpUrl
string

用于访问 Chrome DevTools Protocol 的 WebSocket 地址

liveViewUrl
string

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

expiresAt
string<date-time>

会话按 TTL 计算的过期时间