Saltar al contenido principal
POST
/
interact
Crear una sesión de 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
}

​
Cabeceras

CabeceraValor
AuthorizationBearer <API_KEY>
Content-Typeapplication/json

​
Cuerpo de la solicitud

ParámetroTipoObligatorioValor predeterminadoDescripción
ttlnumberNo600Duración total de la sesión en segundos (30-3600)
activityTtlnumberNo300Segundos de inactividad antes de que la sesión se elimine (10-3600)
profileobjectNo—Habilita el almacenamiento persistente entre sesiones. Consulta más abajo.
profile.namestringSí*—Nombre del perfil (1-128 caracteres). Las sesiones con el mismo nombre comparten almacenamiento.
profile.saveChangesbooleanNotrueCuando es true, el estado del navegador se guarda de nuevo en el perfil al cerrar. Establécelo en false para cargar los datos existentes sin escribir. Solo se permite un proceso de guardado a la vez.

​
Respuesta

CampoTipoDescripción
successbooleanIndica si se creó la sesión
idstringIdentificador único de la sesión
cdpUrlstringURL de WebSocket para conexiones CDP
liveViewUrlstringURL para ver la sesión en tiempo real
interactiveLiveViewUrlstringURL para interactuar con la sesión en tiempo real (hacer clic, escribir, desplazarse)
expiresAtstringMomento en que la sesión expirará según el TTL

​
Ejemplo de solicitud

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

​
Ejemplo de respuesta

{
  "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"
}
¿Eres un agente de IA que necesita una clave de API de Firecrawl? Consulta firecrawl.dev/agent-onboarding/SKILL.md para ver las instrucciones de incorporación automática.

Autorizaciones

​
Authorization
string
header
requerido

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

Cuerpo

application/json
​
activityTtl
integer

Tiempo en segundos antes de que la sesión se destruya por inactividad

Rango requerido: 10 <= x <= 3600
​
profile
object

Habilita el almacenamiento persistente entre sesiones de interact. Los datos guardados en una sesión pueden cargarse en una sesión posterior usando el mismo nombre.

​
streamWebView
boolean
predeterminado:true

Si se debe transmitir una vista en vivo del navegador

​
ttl
integer
predeterminado:300

Tiempo de vida total en segundos de la sesión de interact

Rango requerido: 30 <= x <= 3600

Respuesta

Sesión de interact creada correctamente

​
cdpUrl
string

URL de WebSocket para acceder al Chrome DevTools Protocol

​
expiresAt
string<date-time>

Cuándo expirará la sesión según el TTL

​
id
string

El identificador único de la sesión

​
interactiveLiveViewUrl
string

URL para interactuar con la sesión de interact en tiempo real (clic, escribir, desplazarse)

​
liveViewUrl
string

URL para ver la sesión de interact en tiempo real

​
success
boolean