Encerrar interação

Interrompa a sessão interativa do navegador associada a um job de scraping

curl --request DELETE \
  --url https://api.firecrawl.dev/v2/scrape/{jobId}/interact \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.firecrawl.dev/v2/scrape/{jobId}/interact', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/scrape/{jobId}/interact",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/scrape/{jobId}/interact"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/scrape/{jobId}/interact")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "error": "Forbidden.",
  "success": false
}

{
  "error": "Browser session not found.",
  "success": false
}

DELETE

scrape

{jobId}

interact

Interrompa a sessão interativa do navegador associada a um job de scraping

curl --request DELETE \
  --url https://api.firecrawl.dev/v2/scrape/{jobId}/interact \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.firecrawl.dev/v2/scrape/{jobId}/interact', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/scrape/{jobId}/interact",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/scrape/{jobId}/interact"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/scrape/{jobId}/interact")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "error": "Forbidden.",
  "success": false
}

{
  "error": "Browser session not found.",
  "success": false
}

Use este endpoint para encerrar a sessão interativa do navegador de um job de scraping. Encerrar a sessão libera recursos do navegador e finaliza a cobrança. Os créditos são cobrados com base na duração da sessão: 7 créditos por minuto de navegador se a sessão usou um prompt, ou 2 créditos por minuto de navegador se não usou. A duração é calculada proporcionalmente por segundo, com uma cobrança mínima de um minuto de navegador.

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição
`jobId`	string (UUID)	Sim	O ID do job de scraping associado à sessão do navegador

Resposta

Campo	Tipo	Descrição
`success`	boolean	Indica se a sessão foi encerrada com sucesso
`sessionDurationMs`	number	Duração total da sessão em milissegundos
`creditsBilled`	number	Número de créditos cobrados pela sessão
`error`	string	Mensagem de erro (presente apenas em caso de falha)

Exemplo de requisição

curl -X DELETE "https://api.firecrawl.dev/v2/scrape/550e8400-e29b-41d4-a716-446655440000/interact" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY"

Exemplo de resposta

{
  "success": true
}

Códigos de erro

Status	descrição
`403`	A sessão pertence a uma equipe diferente
`404`	Nenhuma sessão de navegador foi encontrada para este job de scraping

Para um uso mais detalhado, com exemplos, consulte o guia do recurso Interact.

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

jobId

string<uuid>

obrigatório

O ID do job de scraping

Resposta

Sessão interativa do navegador do job de scraping interrompida com sucesso

success

boolean

Usando a API

Endpoints de busca

Endpoints /scrape

Endpoints de interação

Endpoints do Research Index

Endpoints do índice para desenvolvedores

Endpoints de mapeamento

Endpoints de análise

Endpoints de rastreamento

Endpoints de monitoramento

Endpoints de feedback

Endpoints de depuração agêntica

Endpoints da conta

Payloads de webhook

Integração de parceiro

Parâmetros de caminho

Resposta

Exemplo de requisição

Exemplo de resposta

Códigos de erro

Autorizações

Parâmetros de caminho

Resposta

​Parâmetros de caminho

​Resposta

​Exemplo de requisição

​Exemplo de resposta

​Códigos de erro

Autorizações

Parâmetros de caminho

Resposta

Parâmetros de caminho

Resposta

Exemplo de requisição

Exemplo de resposta

Códigos de erro