Passer au contenu principal
POST
/
interact
Créer une session Interact
curl --request POST \
  --url https://api.firecrawl.dev/v2/interact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "activityTtl": 1805,
  "streamWebView": true,
  "ttl": 300
}
'
{
  "cdpUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "interactiveLiveViewUrl": "<string>",
  "liveViewUrl": "<string>",
  "success": true
}

​
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)
profileobjectNon—Active 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/interact" \
  -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"
}
Êtes-vous un agent IA qui a besoin d’une clé API Firecrawl ? Consultez firecrawl.dev/agent-onboarding/SKILL.md pour obtenir les instructions d’intégration automatisée.

Autorisations

​
Authorization
string
header
requis

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

Corps

application/json
​
activityTtl
integer

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

Plage requise: 10 <= x <= 3600
​
profile
object

Active le stockage persistant entre les sessions Interact. Les données enregistrées dans une session peuvent être chargées dans une session ultérieure en utilisant le même nom.

​
streamWebView
boolean
défaut:true

Indique s’il faut diffuser une vue en direct du Browser

​
ttl
integer
défaut:300

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

Plage requise: 30 <= x <= 3600

Réponse

Session Interact créée avec succès

​
cdpUrl
string

URL WebSocket pour accéder au protocole Chrome DevTools

​
expiresAt
string<date-time>

Date d’expiration de la session selon le TTL

​
id
string

Identifiant unique de la session

​
interactiveLiveViewUrl
string

URL pour Interact avec la session Interact en temps réel (cliquer, saisir, faire défiler)

​
liveViewUrl
string

URL pour consulter la session Interact en temps réel

​
success
boolean