Passer au contenu principal
POST
/
browser
Créer une session de navigateur
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
  }
}
'
{
  "success": true,
  "id": "<string>",
  "cdpUrl": "<string>",
  "liveViewUrl": "<string>",
  "interactiveLiveViewUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

En-têtes

En-têteValeur
AuthorizationBearer <API_KEY>
Content-Typeapplication/json

Corps de la requête

ParamètreTypeObligatoireValeur par défautDescription
ttlnumberNon600Durée de vie totale de la session en secondes (30-3600)
activityTtlnumberNon300Nombre de secondes d’inactivité avant la destruction de la session (10-3600)
profileobjectNonActive un stockage persistant d’une session à l’autre. Voir ci-dessous.
profile.namestringOui*Nom du profil (1-128 caractères). Les sessions portant le même nom partagent le stockage.
profile.saveChangesbooleanNontrueLorsque true, l’état du navigateur est enregistré dans le profil à la fermeture. Définissez sur false pour charger les données existantes sans écriture. Un seul enregistreur est autorisé à la fois.

Réponse

ChampTypeDescription
successbooleanIndique si la session a bien été créée
idstringIdentifiant unique de la session
cdpUrlstringURL WebSocket pour les connexions CDP
liveViewUrlstringURL pour afficher la session en temps réel
interactiveLiveViewUrlstringURL pour interagir avec la session en temps réel (clics, saisie, défilement)
expiresAtstringDate d’expiration de la session en fonction du TTL

Exemple de requête

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

Exemple de réponse

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

Autorisations

Authorization
string
header
requis

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

Corps

application/json
ttl
integer
défaut:300

Durée de vie totale de la session de navigateur, en secondes

Plage requise: 30 <= x <= 3600
activityTtl
integer

Temps en secondes avant la destruction de la session pour cause d’inactivité

Plage requise: 10 <= x <= 3600
streamWebView
boolean
défaut:true

Indique s’il faut diffuser un flux en direct du navigateur

profile
object

Activez la persistance du stockage entre les sessions du navigateur. Les données enregistrées lors d’une session peuvent être rechargées dans une session ultérieure en utilisant le même nom.

Réponse

Session de navigateur créée avec succès

success
boolean
id
string

Identifiant unique de la session

cdpUrl
string

URL WebSocket pour accéder au protocole Chrome DevTools

liveViewUrl
string

URL permettant d’afficher la session de navigateur en temps réel

interactiveLiveViewUrl
string

URL permettant d’interagir en temps réel avec la session du navigateur (clic, saisie, défilement)

expiresAt
string<date-time>

Date et heure d’expiration de la session en fonction du TTL