Saltar al contenido principal
POST
/
scrape
/
{jobId}
/
interact
Interactúa con la sesión del navegador asociada a un trabajo de scrape
curl --request POST \
  --url https://api.firecrawl.dev/v2/scrape/{jobId}/interact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "language": "node",
  "timeout": 30,
  "origin": "<string>"
}
'
{
  "success": true,
  "stdout": "<string>",
  "result": "<string>",
  "stderr": "<string>",
  "exitCode": 123,
  "killed": true,
  "error": "<string>"
}
Usa este endpoint para seguir interactuando con el mismo estado del navegador inicializado a partir de un scrape anterior. Debes proporcionar code o prompt, pero no ambos. POST /v2/scrape/{jobId}/interact gestiona el ciclo de vida completo:
  1. Si todavía no existe una sesión del navegador para este trabajo de scrape, Firecrawl crea una con el mismo estado de la página que el scrape original.
  2. Cuando se proporciona code, Firecrawl lo ejecuta en el sandbox del navegador. Cuando se proporciona prompt, un agente de IA automatiza la tarea al utilizar lenguaje natural.
  3. Las llamadas posteriores a POST /interact con el mismo jobId reutilizan el mismo estado activo del navegador.
Cuando hayas terminado, llama a DELETE /v2/scrape/{jobId}/interact para detener la sesión.

​
Parámetros de ruta

ParámetroTipoObligatorioDescripción
jobIdstring (UUID)SíEl ID del trabajo de scrape de data.metadata.scrapeId en la respuesta de scrape

​
Request Body

parámetrotipoRequiredDefaultdescripción
codestringNo—Código que se ejecutará en el sandbox del navegador (1–100,000 caracteres). Obligatorio si no se establece prompt.
promptstringNo—Tarea en lenguaje natural para el agente de IA (1–10,000 caracteres). Obligatorio si no se establece code.
languagestringNo"node"Uno de "python", "node" o "bash". Solo se usa con code.
timeoutnumberNo30Tiempo de espera de ejecución en segundos (1–300).
originstringNo—Etiqueta de origen opcional que se usa para telemetría.

​
respuesta

Fieldtipodescripción
successbooleanSi la ejecución se completó sin errores
liveViewUrlstringURL de vista en vivo de solo lectura para la sesión del navegador
interactiveLiveViewUrlstringURL de vista en vivo interactiva (los espectadores pueden controlar el navegador)
outputstringRespuesta final del agente de IA (solo presente al utilizar prompt)
stdoutstringSalida estándar de la ejecución del código
resultstringValor de retorno — valor de la última expresión para Node.js, instantánea final de la página para prompt
stderrstringSalida de error estándar
exitCodenumberCódigo de salida de la ejecución (0 = éxito)
killedbooleanSi la ejecución se terminó debido al tiempo de espera
errorstringMensaje de error (solo presente en caso de fallo)

​
solicitud de ejemplo (Code)

curl -X POST "https://api.firecrawl.dev/v2/scrape/550e8400-e29b-41d4-a716-446655440000/interact" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "const title = await page.title(); JSON.stringify({ title });",
    "language": "node",
    "timeout": 30
  }'

​
Respuesta de ejemplo (código)

{
  "success": true,
  "liveViewUrl": "https://liveview.firecrawl.dev/...",
  "interactiveLiveViewUrl": "https://liveview.firecrawl.dev/...",
  "stdout": "",
  "result": "{\"title\":\"Example Domain\"}",
  "stderr": "",
  "exitCode": 0,
  "killed": false
}

​
Solicitud de ejemplo (Prompt)

curl -X POST "https://api.firecrawl.dev/v2/scrape/550e8400-e29b-41d4-a716-446655440000/interact" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Find the pricing section and tell me the price of the Pro plan",
    "timeout": 60
  }'

​
respuesta de ejemplo (Prompt)

{
  "success": true,
  "liveViewUrl": "https://liveview.firecrawl.dev/...",
  "interactiveLiveViewUrl": "https://liveview.firecrawl.dev/...",
  "output": "The Pro plan costs $49/month and includes unlimited scrapes, priority support, and custom integrations.",
  "stdout": "...",
  "result": "...",
  "stderr": "",
  "exitCode": 0,
  "killed": false
}

​
Códigos de error

Statusdescripción
402Créditos insuficientes para una sesión del navegador
403El trabajo de scrape pertenece a otro equipo
404No se encontró el trabajo de scrape
409Contexto de repetición no disponible — vuelve a ejecutar el scrape e inténtalo de nuevo
410La sesión del navegador ya ha sido destruida
429Se alcanzó el número máximo de sesiones simultáneas del navegador
502Falló el servicio del navegador o la ejecución del agente de IA
503La función del navegador no está configurada (solo autogestionado)
Para obtener información detallada sobre el uso con ejemplos, consulta la guía de la función Interact.

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
jobId
string<uuid>
requerido

El ID de trabajo de scrape

Cuerpo

application/json
​
code
string
requerido

Código que se ejecutará en el entorno aislado del navegador vinculado al scrape

Required string length: 1 - 100000
​
language
enum<string>
predeterminado:node

Lenguaje del código que se ejecutará. Usa node para JavaScript o bash para comandos de CLI de agent-browser.

Opciones disponibles:
python,
node,
bash
​
timeout
integer
predeterminado:30

timeout de ejecución en segundos

Rango requerido: 1 <= x <= 300
​
origin
string

Etiqueta de origen opcional usada para la telemetría de ejecución

Respuesta

Código ejecutado correctamente

​
success
boolean
​
stdout
string | null

salida estándar de la ejecución del código

​
result
string | null

salida estándar (alias de stdout)

​
stderr
string | null

salida de error estándar de la ejecución del código

​
exitCode
integer | null

Código de salida del proceso ejecutado

​
killed
boolean

Indica si el proceso se finalizó debido a un timeout

​
error
string | null

Mensaje de error si el código generó una excepción