Agente

Iniciar uma tarefa de agente para extração de dados orientada a 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

Iniciar uma tarefa de agente para extração de dados orientada a 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."
}

Você é um agente de IA que precisa de uma chave de API da Firecrawl? Veja firecrawl.dev/agent-onboarding/SKILL.md para instruções automatizadas de integração.

Autorizações

Authorization

string

header

obrigatório

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

Corpo

application/json

prompt

string

obrigatório

O prompt que descreve quais dados devem ser extraídos

Maximum string length: 10000

auditMetadata

object

Identificação do usuário incluída nos eventos de log do SIEM quando o SIEM Logging estiver habilitado para a organização.

Show child attributes

effort

enum<string>

Orçamento de raciocínio para a tarefa do agente. Todas as execuções são realizadas no spark-2, portanto o esforço pode ser enviado com ou sem modelo.

Opções disponíveis:

low,

medium,

high

exchange

object

Permita que o agente chame os providers de dados da sua equipe no Alexandria durante a execução. Sem este object, a execução usa apenas a web (um turno de acompanhamento herda as configurações do turno anterior). Consulte Use suas ferramentas conectadas do Alexandria.

Show child attributes

maxCredits

number

Máximo de créditos a serem gastos nesta tarefa do agente. O padrão é 2500 se não for definido. Valores acima de 2.500 são sempre cobrados como requisições pagas.

mode

enum<string>

padrão:extract

extract retorna o resultado estruturado completo em data a cada turno. chat permite responder a uma solicitação de acompanhamento que não peça novos dados com uma resposta curta em message, em vez de executar novamente. exchange.requireApproval exige chat na mesma solicitação. Se omitido em um turno de acompanhamento, o modo da conversa é mantido.

Opções disponíveis:

extract,

chat

model

enum<string>

padrão:spark-2

Modelo a ser usado na tarefa do agente. spark-2 é o padrão, e todas as execuções são realizadas nele. Os nomes de modelo Spark 1 continuam aceitos para compatibilidade retroativa, mas estão descontinuados e são direcionados para spark-2.

Opções disponíveis:

spark-2,

spark-1-mini,

spark-1-pro

schema

object

Esquema JSON opcional para estruturar os dados extraídos

strictConstrainToURLs

boolean

Se verdadeiro, o agente visitará somente as URLs fornecidas no array urls

threadId

string<uuid>

Continue uma conversa existente: passe o threadId retornado por uma execução anterior para executar esta solicitação como o próximo turno dessa conversa. As configurações de urls, schema, effort, mode e exchange omitidas são herdadas do turno anterior. Omita threadId para iniciar uma nova conversa.

threatProtection

Threat Protection Override · object

Substituição por solicitação da Proteção contra ameaças. Os campos fornecidos substituem os campos correspondentes da política da sua organização apenas nesta solicitação; os campos omitidos mantêm os valores definidos no nível da organização. Exige que a Proteção contra ameaças esteja habilitada para sua equipe (recurso enterprise) — caso contrário, a solicitação será rejeitada com 403. Se sua organização tiver desativado substituições por solicitação, qualquer solicitação que inclua este objeto será rejeitada com 403. Se a Proteção contra ameaças for imposta à sua equipe, mode não poderá ser definido como off.

Show child attributes

urls

string<uri>[]

Lista opcional de URLs às quais o agente ficará restrito

webhook

object

Um objeto de especificação de webhook. Inscreve-se em eventos do ciclo de vida do agente (agent.started, agent.action, agent.completed, agent.failed, agent.cancelled).

Show child attributes

Resposta

Tarefa do agente iniciada com sucesso

string<uuid>

success

boolean

threadId

string<uuid>

A conversa à qual esta execução pertence. Passe esse valor como threadId para continuar a conversa.

threadTurn

integer

O turno desta execução na conversa, com numeração a partir de 1.

Usando a API

Endpoints de busca

Endpoints /scrape

Endpoints para interagir / Browser Sandbox

Endpoints do Research Index

Endpoints do índice para desenvolvedores

Endpoints do índice governamental

Endpoints de mapeamento

Endpoints de Parse

Endpoints de rastreamento

Endpoints de monitoramento

Endpoints de agente

Endpoints de feedback

Endpoints de depuração agêntica

Endpoints da conta

Payloads de webhook

Firecrawl for Platforms

Autorizações

Corpo

Resposta