Criar sessão do Interact

Inicia uma sessão independente do navegador Interact que você controla com código (sem scraping prévio).

POST /interact

Criar uma sessão de interação

cURL

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

200

{
  "cdpUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "interactiveLiveViewUrl": "<string>",
  "liveViewUrl": "<string>",
  "success": true
}

​

Cabeçalhos

Cabeçalho	Valor
Authorization	Bearer <API_KEY>
Content-Type	application/json

​

Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
ttl	number	Não	600	Tempo de vida total da sessão, em segundos (30-3600)
activityTtl	number	Não	300	Número de segundos de inatividade antes que a sessão seja destruída (10-3600)
profile	object	Não	—	Habilita armazenamento persistente entre sessões. Veja abaixo.
profile.name	string	Sim*	—	Nome do perfil (1-128 caracteres). Sessões com o mesmo nome compartilham o armazenamento.
profile.saveChanges	boolean	Não	true	Quando true, o estado do navegador é salvo de volta no perfil ao fechar. Defina como false para carregar dados existentes sem gravar. Apenas um salvamento é permitido por vez.

​

Resposta

Campo	Tipo	Descrição
success	boolean	Indica se a sessão foi criada
id	string	Identificador único da sessão
cdpUrl	string	URL WebSocket para conexões CDP
liveViewUrl	string	URL para assistir à sessão em tempo real
interactiveLiveViewUrl	string	URL para interagir com a sessão em tempo real (clicar, digitar, rolar)
expiresAt	string	Quando a sessão expira com base no TTL

​

Exemplo de requisição

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

​

Resposta de exemplo

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

Você é um agente de IA que precisa de uma chave de API do Firecrawl? Consulte firecrawl.dev/agent-onboarding/SKILL.md para obter instruções de onboarding automatizado.

Autorizações

Authorization · string · header · obrigatório

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

Corpo

application/json

activityTtl · integer

Tempo, em segundos, antes que a sessão seja encerrada por inatividade

Intervalo obrigatório: 10 <= x <= 3600

profile · object

Ativa o armazenamento persistente entre sessões de interação. Os dados salvos em uma sessão podem ser carregados em uma sessão posterior usando o mesmo nome.

Show child attributes

streamWebView · boolean · padrão: true

Se deve transmitir uma visualização em tempo real do navegador

ttl · integer · padrão: 300

Tempo de vida total, em segundos, da sessão de interação

Intervalo obrigatório: 30 <= x <= 3600

Resposta

200

application/json

Sessão de interação criada com sucesso

cdpUrl · string

URL do WebSocket para acesso ao Chrome DevTools Protocol

expiresAt · string<date-time>

Quando a sessão expirará com base no TTL

id · string

O identificador único da sessão

interactiveLiveViewUrl · string

URL para interagir com a sessão de interação em tempo real (clicar, digitar, rolar)

liveViewUrl · string

URL para visualizar a sessão de interação em tempo real

success · boolean