ブラウザーセッションの作成

サンドボックス環境で新しいクラウドブラウザーセッションを起動します。

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"
}

​

ヘッダー

ヘッダー	値
Authorization	Bearer <API_KEY>
Content-Type	application/json

​

リクエストボディ

Parameter	Type	Required	Default	Description
ttl	number	No	600	セッション全体の有効期間（秒）（30〜3600）
activityTtl	number	No	300	セッションが破棄されるまでの非アクティブ状態の継続時間（秒）（10〜3600）
profile	object	No	—	セッション間での永続的なストレージを有効化します。後述を参照してください。
profile.name	string	Yes*	—	プロファイルの名前（1〜128文字）。同じ名前のセッションはストレージを共有します。
profile.saveChanges	boolean	No	true	true の場合、ブラウザの状態は終了時にプロファイルへ保存されます。既存データの読み込みのみを行いたい場合は false を設定してください。保存処理を行えるセッションは同時に 1 つだけです。

​

レスポンス

フィールド	型	説明
success	boolean	セッションが作成されたかどうか
id	string	セッションの一意の識別子
cdpUrl	string	CDP 接続用の WebSocket URL
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 URL

liveViewUrl · string

ブラウザーセッションをリアルタイムで表示するための URL

interactiveLiveViewUrl · string

ブラウザセッションをリアルタイムに操作するためのURL（クリック、入力、スクロール）

expiresAt · string<date-time>

TTL に基づくセッションの有効期限