Deep Research

POST /deep-research

Iniciar uma operação de pesquisa aprofundada com base em uma consulta

cURL

curl --request POST \
  --url https://api.firecrawl.dev/v1/deep-research \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "analysisPrompt": "<string>",
  "formats": [
    "markdown"
  ],
  "jsonOptions": {
    "prompt": "<string>",
    "schema": {},
    "systemPrompt": "<string>"
  },
  "maxDepth": 7,
  "maxUrls": 20,
  "systemPrompt": "<string>",
  "timeLimit": 300
}
'

import requests

url = "https://api.firecrawl.dev/v1/deep-research"

payload = {
    "query": "<string>",
    "analysisPrompt": "<string>",
    "formats": ["markdown"],
    "jsonOptions": {
        "prompt": "<string>",
        "schema": {},
        "systemPrompt": "<string>"
    },
    "maxDepth": 7,
    "maxUrls": 20,
    "systemPrompt": "<string>",
    "timeLimit": 300
}
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({
    query: '<string>',
    analysisPrompt: '<string>',
    formats: ['markdown'],
    jsonOptions: {prompt: '<string>', schema: {}, systemPrompt: '<string>'},
    maxDepth: 7,
    maxUrls: 20,
    systemPrompt: '<string>',
    timeLimit: 300
  })
};

fetch('https://api.firecrawl.dev/v1/deep-research', 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/v1/deep-research",
  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([
    'query' => '<string>',
    'analysisPrompt' => '<string>',
    'formats' => [
        'markdown'
    ],
    'jsonOptions' => [
        'prompt' => '<string>',
        'schema' => [
                
        ],
        'systemPrompt' => '<string>'
    ],
    'maxDepth' => 7,
    'maxUrls' => 20,
    'systemPrompt' => '<string>',
    'timeLimit' => 300
  ]),
  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/v1/deep-research"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"analysisPrompt\": \"<string>\",\n  \"formats\": [\n    \"markdown\"\n  ],\n  \"jsonOptions\": {\n    \"prompt\": \"<string>\",\n    \"schema\": {},\n    \"systemPrompt\": \"<string>\"\n  },\n  \"maxDepth\": 7,\n  \"maxUrls\": 20,\n  \"systemPrompt\": \"<string>\",\n  \"timeLimit\": 300\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/v1/deep-research")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"analysisPrompt\": \"<string>\",\n  \"formats\": [\n    \"markdown\"\n  ],\n  \"jsonOptions\": {\n    \"prompt\": \"<string>\",\n    \"schema\": {},\n    \"systemPrompt\": \"<string>\"\n  },\n  \"maxDepth\": 7,\n  \"maxUrls\": 20,\n  \"systemPrompt\": \"<string>\",\n  \"timeLimit\": 300\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v1/deep-research")

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  \"query\": \"<string>\",\n  \"analysisPrompt\": \"<string>\",\n  \"formats\": [\n    \"markdown\"\n  ],\n  \"jsonOptions\": {\n    \"prompt\": \"<string>\",\n    \"schema\": {},\n    \"systemPrompt\": \"<string>\"\n  },\n  \"maxDepth\": 7,\n  \"maxUrls\": 20,\n  \"systemPrompt\": \"<string>\",\n  \"timeLimit\": 300\n}"

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

200

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

{
  "error": "Invalid parameters provided",
  "success": false
}

O endpoint Deep Research possibilita pesquisa e análise aprofundadas com IA sobre qualquer tema. Basta fornecer uma consulta de pesquisa e o Firecrawl explorará a web de forma autônoma, reunirá informações relevantes e sintetizará os achados em insights abrangentes.

Esta é a API legada v1 do Deep Research. Para novos agentes de pesquisa, use o caso de uso atual de Deep Research, que é construído a partir de Search e Scrape.

Procurando o endpoint de status? Confira o endpoint Deep Research Status.

Estrutura da resposta

A resposta inclui:

• activities: Lista de atividades de pesquisa com:

  • type: Tipo de atividade (‘search’, ‘extract’, ‘analyze’, ‘reasoning’, ‘synthesis’, ‘thought’)
  • status: Status (‘processing’, ‘complete’, ‘error’)
  • message: Descrição da atividade/descoberta
  • timestamp: Carimbo de data e hora em formato ISO
  • depth: Nível de profundidade da pesquisa

• sources: URLs de referência com:

  • title: Título da fonte
  • description: Descrição da fonte
  • url: URL da fonte
  • icon: Favicon da fonte

• finalAnalysis: Análise abrangente (quando concluída)

• status: Status geral (‘processing’, ‘completed’, ‘failed’)

• currentDepth: Profundidade de pesquisa atual

• maxDepth: Profundidade máxima de pesquisa

• totalUrls: Número de URLs analisadas

• expiresAt: Carimbo de data e hora ISO da expiração dos resultados

Limitações

1. Mais indicado para tópicos com informações de domínio público
2. Tarefas de pesquisa limitadas a, no máximo, 10 minutos
3. Recomenda-se verificação manual para informações críticas
4. Recurso em fase alfa — metodologia e resultados podem evoluir

Cobrança

A cobrança é baseada na quantidade de URLs analisadas:

• Cada URL = 1 crédito
• Controle o uso por meio do parâmetro maxUrls

Authorizations

Authorization · string · header · required

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

Body

application/json

query · string · required

Consulta de pesquisa

analysisPrompt · string

O prompt a ser usado na análise final. Útil para definir o formato do markdown da análise final de uma maneira específica.

formats · enum<string>[]

Available options: markdown, json

jsonOptions · object

Opções de saída em JSON

Show child attributes

maxDepth · integer · default: 7

Profundidade máxima de iterações de pesquisa

Required range: 1 <= x <= 12

maxUrls · integer · default: 20

Número máximo de URLs para analisar

Required range: 1 <= x <= 1000

systemPrompt · string

O prompt de sistema a ser usado pelo agente de pesquisa. Útil para orientar o agente de pesquisa em uma direção específica.

timeLimit · integer · default: 300

Limite de tempo em segundos

Required range: 30 <= x <= 600

Response

200

application/json

Processo de pesquisa iniciado com sucesso

id · string<uuid>

ID da tarefa de pesquisa

success · boolean

Example:

true