Récupérer l’état de l’agent

Récupérer l’état d’une tâche d’agent

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

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

fetch('https://api.firecrawl.dev/v2/agent/{jobId}', 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/agent/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/agent/{jobId}"

	req, _ := http.NewRequest("GET", 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/agent/{jobId}")

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

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

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

{
  "creditsUsed": 123,
  "data": {},
  "effort": "low",
  "error": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "message": "<string>",
  "model": "spark-2",
  "partial": "<unknown>",
  "partialSchemaValid": true,
  "status": "processing",
  "stopReason": "credit_limit_reached",
  "success": true
}

{
  "error": "Invalid job ID format. Job ID must be a valid UUID."
}

{
  "error": "Agent job not found"
}

GET

agent

{jobId}

Récupérer l’état d’une tâche d’agent

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

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

fetch('https://api.firecrawl.dev/v2/agent/{jobId}', 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/agent/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/agent/{jobId}"

	req, _ := http.NewRequest("GET", 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/agent/{jobId}")

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

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

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

{
  "creditsUsed": 123,
  "data": {},
  "effort": "low",
  "error": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "message": "<string>",
  "model": "spark-2",
  "partial": "<unknown>",
  "partialSchemaValid": true,
  "status": "processing",
  "stopReason": "credit_limit_reached",
  "success": true
}

{
  "error": "Invalid job ID format. Job ID must be a valid UUID."
}

{
  "error": "Agent job not found"
}

Êtes-vous un agent IA qui a besoin d’une clé API Firecrawl ? Consultez firecrawl.dev/agent-onboarding/SKILL.md pour obtenir des 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.

Paramètres de chemin

jobId

string<uuid>

requis

L’ID de la tâche de l’agent

Réponse

Réponse réussie

creditsUsed

number

data

object

Les données extraites (uniquement présentes lorsque l’état est « completed »). Jamais renseignées pour une exécution ayant échoué, y compris si elle s’est arrêtée après avoir atteint sa limite de crédits.

effort

enum<string>

Budget de raisonnement utilisé pour l’exécution d’agent (présent uniquement pour les exécutions ayant défini le paramètre effort)

Options disponibles:

low,

medium,

high

error

string

Message d’erreur (présent uniquement lorsque le statut est « failed »)

expiresAt

string<date-time>

message

string

Une note de l’agent concernant le résultat. Si l’exécution a échoué après avoir atteint sa limite de crédits, cette note peut préciser ce qui est incomplet.

model

enum<string>

défaut:spark-2

Préréglage du modèle utilisé lors de l’exécution de l’agent. Chaque nouvelle exécution utilise spark-2 ; les noms Spark 1 n’apparaissent que dans les exécutions héritées.

Options disponibles:

spark-2,

spark-1-pro,

spark-1-mini

partial

any

JSON récupéré dans la mesure du possible à partir d’une exécution incomplète. Présent uniquement pour certaines exécutions ayant échoué, notamment celles ayant atteint maxCredits ; jamais présent pendant le traitement de l’exécution. Des lignes ou des champs peuvent manquer : ne le considérez donc pas comme un résultat complet.

partialSchemaValid

boolean

Indique si partial est conforme au schéma JSON de la requête. Présent uniquement si partial est présent et si la requête incluait un schema.

status

enum<string>

Options disponibles:

processing,

completed,

failed

stopReason

enum<string>

Raison de l’arrêt prématuré d’une exécution ayant échoué. credit_limit_reached signifie que l’exécution a atteint sa limite maxCredits. Présente uniquement lorsque l’état est « failed ».

Options disponibles:

credit_limit_reached

success

boolean

Utilisation de l’API

Points de terminaison de recherche

Points de terminaison de scraping

Points de terminaison Interact / Browser Sandbox

Points de terminaison de Research Index

Points de terminaison de l’index développeur

Points de terminaison de cartographie

Points de terminaison d’analyse

Points de terminaison crawl

Points de terminaison de surveillance

Points de terminaison Agent

Points de terminaison de retour

Points de terminaison de débogage agentique

Points de terminaison du compte

Charges utiles de webhook

Firecrawl pour les plateformes

Récupérer l’état de l’agent

Autorisations

Paramètres de chemin

Réponse