Agent

Démarrer une tâche d’agent pour l’extraction de données pilotée par un agent

curl --request POST \
  --url https://api.firecrawl.dev/v2/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "exchange": {
    "enabled": true,
    "maxCalls": 16,
    "onTermsRequired": "skip",
    "requireApproval": false,
    "toolkits": [
      "<string>"
    ]
  },
  "maxCredits": 123,
  "mode": "extract",
  "model": "spark-2",
  "schema": {},
  "strictConstrainToURLs": true,
  "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "threatProtection": {
    "blacklist": [
      "<string>"
    ],
    "blockedTlds": [
      "<string>"
    ],
    "riskScoreThreshold": 75,
    "whitelist": [
      "<string>"
    ]
  },
  "urls": [
    "<string>"
  ]
}
'

import requests

url = "https://api.firecrawl.dev/v2/agent"

payload = {
    "prompt": "<string>",
    "exchange": {
        "enabled": True,
        "maxCalls": 16,
        "onTermsRequired": "skip",
        "requireApproval": False,
        "toolkits": ["<string>"]
    },
    "maxCredits": 123,
    "mode": "extract",
    "model": "spark-2",
    "schema": {},
    "strictConstrainToURLs": True,
    "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "threatProtection": {
        "blacklist": ["<string>"],
        "blockedTlds": ["<string>"],
        "riskScoreThreshold": 75,
        "whitelist": ["<string>"]
    },
    "urls": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: '<string>',
    exchange: {
      enabled: true,
      maxCalls: 16,
      onTermsRequired: 'skip',
      requireApproval: false,
      toolkits: ['<string>']
    },
    maxCredits: 123,
    mode: 'extract',
    model: 'spark-2',
    schema: {},
    strictConstrainToURLs: true,
    threadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    threatProtection: {
      blacklist: ['<string>'],
      blockedTlds: ['<string>'],
      riskScoreThreshold: 75,
      whitelist: ['<string>']
    },
    urls: ['<string>']
  })
};

fetch('https://api.firecrawl.dev/v2/agent', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => '<string>',
    'exchange' => [
        'enabled' => true,
        'maxCalls' => 16,
        'onTermsRequired' => 'skip',
        'requireApproval' => false,
        'toolkits' => [
                '<string>'
        ]
    ],
    'maxCredits' => 123,
    'mode' => 'extract',
    'model' => 'spark-2',
    'schema' => [
        
    ],
    'strictConstrainToURLs' => true,
    'threadId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'threatProtection' => [
        'blacklist' => [
                '<string>'
        ],
        'blockedTlds' => [
                '<string>'
        ],
        'riskScoreThreshold' => 75,
        'whitelist' => [
                '<string>'
        ]
    ],
    'urls' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.firecrawl.dev/v2/agent"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"exchange\": {\n    \"enabled\": true,\n    \"maxCalls\": 16,\n    \"onTermsRequired\": \"skip\",\n    \"requireApproval\": false,\n    \"toolkits\": [\n      \"<string>\"\n    ]\n  },\n  \"maxCredits\": 123,\n  \"mode\": \"extract\",\n  \"model\": \"spark-2\",\n  \"schema\": {},\n  \"strictConstrainToURLs\": true,\n  \"threadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threatProtection\": {\n    \"blacklist\": [\n      \"<string>\"\n    ],\n    \"blockedTlds\": [\n      \"<string>\"\n    ],\n    \"riskScoreThreshold\": 75,\n    \"whitelist\": [\n      \"<string>\"\n    ]\n  },\n  \"urls\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v2/agent")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"exchange\": {\n    \"enabled\": true,\n    \"maxCalls\": 16,\n    \"onTermsRequired\": \"skip\",\n    \"requireApproval\": false,\n    \"toolkits\": [\n      \"<string>\"\n    ]\n  },\n  \"maxCredits\": 123,\n  \"mode\": \"extract\",\n  \"model\": \"spark-2\",\n  \"schema\": {},\n  \"strictConstrainToURLs\": true,\n  \"threadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threatProtection\": {\n    \"blacklist\": [\n      \"<string>\"\n    ],\n    \"blockedTlds\": [\n      \"<string>\"\n    ],\n    \"riskScoreThreshold\": 75,\n    \"whitelist\": [\n      \"<string>\"\n    ]\n  },\n  \"urls\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/agent")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"<string>\",\n  \"exchange\": {\n    \"enabled\": true,\n    \"maxCalls\": 16,\n    \"onTermsRequired\": \"skip\",\n    \"requireApproval\": false,\n    \"toolkits\": [\n      \"<string>\"\n    ]\n  },\n  \"maxCredits\": 123,\n  \"mode\": \"extract\",\n  \"model\": \"spark-2\",\n  \"schema\": {},\n  \"strictConstrainToURLs\": true,\n  \"threadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threatProtection\": {\n    \"blacklist\": [\n      \"<string>\"\n    ],\n    \"blockedTlds\": [\n      \"<string>\"\n    ],\n    \"riskScoreThreshold\": 75,\n    \"whitelist\": [\n      \"<string>\"\n    ]\n  },\n  \"urls\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "threadTurn": 123
}

{
  "error": "Invalid JSON schema: ..."
}

{
  "error": "Payment required to access this resource."
}

{
  "error": "This URL (https://example.com) is blocked by your organization's threat protection policy (rule: blocklist). If you believe this is a mistake, contact your organization administrator to adjust the policy (e.g. whitelist the domain)."
}

{
  "error": "Rate limit exceeded."
}

{
  "error": "Failed to passthrough agent request."
}

POST

agent

Démarrer une tâche d’agent pour l’extraction de données pilotée par un agent

curl --request POST \
  --url https://api.firecrawl.dev/v2/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "exchange": {
    "enabled": true,
    "maxCalls": 16,
    "onTermsRequired": "skip",
    "requireApproval": false,
    "toolkits": [
      "<string>"
    ]
  },
  "maxCredits": 123,
  "mode": "extract",
  "model": "spark-2",
  "schema": {},
  "strictConstrainToURLs": true,
  "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "threatProtection": {
    "blacklist": [
      "<string>"
    ],
    "blockedTlds": [
      "<string>"
    ],
    "riskScoreThreshold": 75,
    "whitelist": [
      "<string>"
    ]
  },
  "urls": [
    "<string>"
  ]
}
'

import requests

url = "https://api.firecrawl.dev/v2/agent"

payload = {
    "prompt": "<string>",
    "exchange": {
        "enabled": True,
        "maxCalls": 16,
        "onTermsRequired": "skip",
        "requireApproval": False,
        "toolkits": ["<string>"]
    },
    "maxCredits": 123,
    "mode": "extract",
    "model": "spark-2",
    "schema": {},
    "strictConstrainToURLs": True,
    "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "threatProtection": {
        "blacklist": ["<string>"],
        "blockedTlds": ["<string>"],
        "riskScoreThreshold": 75,
        "whitelist": ["<string>"]
    },
    "urls": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: '<string>',
    exchange: {
      enabled: true,
      maxCalls: 16,
      onTermsRequired: 'skip',
      requireApproval: false,
      toolkits: ['<string>']
    },
    maxCredits: 123,
    mode: 'extract',
    model: 'spark-2',
    schema: {},
    strictConstrainToURLs: true,
    threadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    threatProtection: {
      blacklist: ['<string>'],
      blockedTlds: ['<string>'],
      riskScoreThreshold: 75,
      whitelist: ['<string>']
    },
    urls: ['<string>']
  })
};

fetch('https://api.firecrawl.dev/v2/agent', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => '<string>',
    'exchange' => [
        'enabled' => true,
        'maxCalls' => 16,
        'onTermsRequired' => 'skip',
        'requireApproval' => false,
        'toolkits' => [
                '<string>'
        ]
    ],
    'maxCredits' => 123,
    'mode' => 'extract',
    'model' => 'spark-2',
    'schema' => [
        
    ],
    'strictConstrainToURLs' => true,
    'threadId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'threatProtection' => [
        'blacklist' => [
                '<string>'
        ],
        'blockedTlds' => [
                '<string>'
        ],
        'riskScoreThreshold' => 75,
        'whitelist' => [
                '<string>'
        ]
    ],
    'urls' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.firecrawl.dev/v2/agent"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"exchange\": {\n    \"enabled\": true,\n    \"maxCalls\": 16,\n    \"onTermsRequired\": \"skip\",\n    \"requireApproval\": false,\n    \"toolkits\": [\n      \"<string>\"\n    ]\n  },\n  \"maxCredits\": 123,\n  \"mode\": \"extract\",\n  \"model\": \"spark-2\",\n  \"schema\": {},\n  \"strictConstrainToURLs\": true,\n  \"threadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threatProtection\": {\n    \"blacklist\": [\n      \"<string>\"\n    ],\n    \"blockedTlds\": [\n      \"<string>\"\n    ],\n    \"riskScoreThreshold\": 75,\n    \"whitelist\": [\n      \"<string>\"\n    ]\n  },\n  \"urls\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v2/agent")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"exchange\": {\n    \"enabled\": true,\n    \"maxCalls\": 16,\n    \"onTermsRequired\": \"skip\",\n    \"requireApproval\": false,\n    \"toolkits\": [\n      \"<string>\"\n    ]\n  },\n  \"maxCredits\": 123,\n  \"mode\": \"extract\",\n  \"model\": \"spark-2\",\n  \"schema\": {},\n  \"strictConstrainToURLs\": true,\n  \"threadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threatProtection\": {\n    \"blacklist\": [\n      \"<string>\"\n    ],\n    \"blockedTlds\": [\n      \"<string>\"\n    ],\n    \"riskScoreThreshold\": 75,\n    \"whitelist\": [\n      \"<string>\"\n    ]\n  },\n  \"urls\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/agent")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"<string>\",\n  \"exchange\": {\n    \"enabled\": true,\n    \"maxCalls\": 16,\n    \"onTermsRequired\": \"skip\",\n    \"requireApproval\": false,\n    \"toolkits\": [\n      \"<string>\"\n    ]\n  },\n  \"maxCredits\": 123,\n  \"mode\": \"extract\",\n  \"model\": \"spark-2\",\n  \"schema\": {},\n  \"strictConstrainToURLs\": true,\n  \"threadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threatProtection\": {\n    \"blacklist\": [\n      \"<string>\"\n    ],\n    \"blockedTlds\": [\n      \"<string>\"\n    ],\n    \"riskScoreThreshold\": 75,\n    \"whitelist\": [\n      \"<string>\"\n    ]\n  },\n  \"urls\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "threadTurn": 123
}

{
  "error": "Invalid JSON schema: ..."
}

{
  "error": "Payment required to access this resource."
}

{
  "error": "This URL (https://example.com) is blocked by your organization's threat protection policy (rule: blocklist). If you believe this is a mistake, contact your organization administrator to adjust the policy (e.g. whitelist the domain)."
}

{
  "error": "Rate limit exceeded."
}

{
  "error": "Failed to passthrough agent request."
}

Ê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.

Corps

application/json

prompt

string

requis

Le prompt décrivant les données à extraire

Maximum string length: 10000

auditMetadata

object

Informations d’attribution de l’utilisateur incluses dans les événements de journalisation SIEM lorsque SIEM Logging est activé pour l’organisation.

Show child attributes

effort

enum<string>

Budget de raisonnement pour la tâche d’agent. Chaque exécution utilise spark-2, donc le paramètre effort peut être envoyé avec ou sans modèle.

Options disponibles:

low,

medium,

high

exchange

object

Autorisez l’agent à appeler les fournisseurs de données Alexandria de votre équipe pendant l’exécution. Sans cet object, l’exécution utilise uniquement le web (un tour de suivi hérite des paramètres du tour précédent). Voir Utiliser vos outils Alexandria connectés.

Show child attributes

maxCredits

number

<[ { "key": "0", "translation": "Nombre maximal de crédits à utiliser pour cette tâche d’agent. La valeur par défaut est de 2500 si elle n’est pas spécifiée. Les valeurs supérieures à 2 500 sont toujours facturées comme des requêtes payantes." } ]</>

mode

enum<string>

défaut:extract

extract renvoie le résultat structuré complet dans data à chaque tour. Avec chat, une demande de suivi ne sollicitant aucune nouvelle donnée reçoit une réponse courte dans message au lieu de déclencher une nouvelle exécution. exchange.requireApproval nécessite chat dans la même requête. Si ce paramètre est omis lors d’un tour de suivi, le mode du fil est conservé.

Options disponibles:

extract,

chat

model

enum<string>

défaut:spark-2

Le modèle à utiliser pour les tâches d’agent. spark-2 est le modèle par défaut et celui sur lequel chaque exécution est effectuée. Les noms de modèles Spark 1 restent acceptés pour assurer la rétrocompatibilité, mais sont obsolètes et redirigent vers spark-2.

Options disponibles:

spark-2,

spark-1-mini,

spark-1-pro

schema

object

Schéma JSON facultatif pour structurer les données extraites

strictConstrainToURLs

boolean

Si la valeur est true, l’agent ne visitera que les URL fournies dans le tableau urls

threadId

string<uuid>

Poursuivez un fil existant : transmettez le threadId renvoyé par une exécution précédente pour que cette requête constitue le tour suivant du fil. Les paramètres urls, schema, effort, mode et exchange omis conservent les valeurs du tour précédent. Omettez threadId pour démarrer un nouveau fil.

threatProtection

Threat Protection Override · object

Dérogation Protection contre les menaces au niveau de la requête. Les champs que vous fournissez remplacent les champs correspondants de la politique de votre organisation pour cette requête uniquement ; les champs omis conservent leurs valeurs définies au niveau de l'organisation. La Protection contre les menaces doit être activée pour votre équipe (fonctionnalité Enterprise) ; sinon, la requête est rejetée avec un code 403. Si votre organisation a désactivé les dérogations par requête, toute requête qui inclut cet objet est rejetée avec un code 403. Si la Protection contre les menaces est appliquée à votre équipe, mode ne peut pas être défini sur off.

Show child attributes

urls

string<uri>[]

Liste facultative d’URL servant à limiter l’agent

webhook

object

Objet de spécification de webhook. S’abonne aux événements du cycle de vie de l’agent (agent.started, agent.action, agent.completed, agent.failed, agent.cancelled).

Show child attributes

Réponse

La tâche de l’agent a démarré avec succès

string<uuid>

success

boolean

threadId

string<uuid>

Le fil auquel appartient cette exécution. Transmettez cette valeur dans threadId pour poursuivre le fil.

threadTurn

integer

Le numéro du tour de cette exécution dans le fil, à partir de 1.

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 l’index gouvernemental

Points de terminaison de cartographie

Points de terminaison d’analyse

Points de terminaison de 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 for Platforms

Autorisations

Corps

Réponse