Agente

Inicia una tarea de agente para la extracción de datos mediante agentes

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

Inicia una tarea de agente para la extracción de datos mediante agentes

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

¿Eres un agente de IA que necesita una clave de API de Firecrawl? Consulta firecrawl.dev/agent-onboarding/SKILL.md para ver instrucciones de incorporación automatizada.

Autorizaciones

Authorization

string

header

requerido

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

Cuerpo

application/json

prompt

string

requerido

El prompt que describe los datos que se van a extraer

Maximum string length: 10000

auditMetadata

object

Atribución de usuario incluida en los eventos de registro SIEM cuando SIEM Logging está habilitado para la organización.

Show child attributes

effort

enum<string>

Presupuesto de razonamiento para la tarea del agente. Cada ejecución se realiza en spark-2, por lo que se puede enviar effort con o sin especificar el modelo.

Opciones disponibles:

low,

medium,

high

exchange

object

Permite que el agente llame a los providers de datos de Alexandria de tu equipo durante la ejecución. Sin este objeto, la ejecución usa solo la web (un turno de seguimiento hereda los ajustes del turno anterior). Consulta Usa tus herramientas conectadas de Alexandria.

Show child attributes

maxCredits

number

Créditos máximos que se pueden gastar en esta tarea del agente. El valor predeterminado es 2500 si no se especifica. Los valores superiores a 2.500 siempre se facturan como solicitudes de pago.

mode

enum<string>

predeterminado:extract

extract devuelve el resultado estructurado completo en data en cada turno. chat permite responder brevemente en message a una solicitud de seguimiento que no pida datos nuevos, sin volver a ejecutar la tarea. exchange.requireApproval requiere chat en la misma solicitud. Si se omite en un turno de seguimiento, se conserva el modo del hilo.

Opciones disponibles:

extract,

chat

model

enum<string>

predeterminado:spark-2

El modelo que utilizará el agente para la tarea. spark-2 es el predeterminado y el modelo que utiliza cada ejecución. Los nombres de modelos Spark 1 siguen aceptándose por compatibilidad con versiones anteriores, pero están obsoletos y se redirigen a spark-2.

Opciones disponibles:

spark-2,

spark-1-mini,

spark-1-pro

schema

object

Esquema JSON opcional para estructurar los datos extraídos

strictConstrainToURLs

boolean

Si es true, el agente solo visitará las URL proporcionadas en el array urls

threadId

string<uuid>

Continúa un hilo existente: pasa el threadId devuelto por una ejecución anterior y esta solicitud se ejecutará como el siguiente turno de ese hilo. Si se omiten los ajustes de urls, schema, effort, mode y exchange, se conservarán los del turno anterior. Omite threadId para iniciar un nuevo hilo.

threatProtection

Threat Protection Override · object

Anulación por solicitud de Protección contra amenazas. Los campos que proporciones reemplazan los campos correspondientes de la política de tu organización solo para esta solicitud; los campos omitidos conservan sus valores a nivel de organización. Requiere que Protección contra amenazas esté habilitada para tu equipo (función enterprise); de lo contrario, la solicitud se rechaza con un 403. Si tu organización ha deshabilitado las anulaciones por solicitud, cualquier solicitud que incluya este objeto se rechaza con un 403. Si Protección contra amenazas se aplica de forma obligatoria a tu equipo, mode no puede establecerse en off.

Show child attributes

urls

string<uri>[]

Lista opcional de URLs a las que se limitará el agente

webhook

object

Un objeto de especificación de webhook. Se suscribe a eventos del ciclo de vida del agente (agent.started, agent.action, agent.completed, agent.failed, agent.cancelled).

Show child attributes

Respuesta

La tarea del agente se inició correctamente

string<uuid>

success

boolean

threadId

string<uuid>

El hilo al que pertenece esta ejecución. Pásalo como threadId para continuar el hilo.

threadTurn

integer

El turno de esta ejecución en el hilo, empezando por 1.

Uso de la API

Endpoints de búsqueda

Endpoints de scraping

Endpoints de interacción / sandbox del navegador

Endpoints de Research Index

Endpoints de developer index

Puntos de conexión del índice gubernamental

Puntos de conexión de mapeo

Puntos de conexión de procesamiento

Puntos de conexión de rastreo

Puntos de conexión para supervisar

Puntos de conexión de agentes

Puntos de conexión de comentarios

Puntos de conexión de depuración con agentes

Puntos de conexión de la cuenta

Cargas útiles de webhook

Firecrawl for Platforms

Autorizaciones

Cuerpo

Respuesta