Pesquise no índice para desenvolvedores

curl --request GET \
  --url https://api.firecrawl.dev/v2/search/developer \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.firecrawl.dev/v2/search/developer', 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/search/developer",
  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/search/developer"

	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/search/developer")

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

{
  "coverage": {
    "doc": "ok",
    "issue": "ok",
    "pull_request": "ok",
    "readme": "ok"
  },
  "reranked": true,
  "results": [
    {
      "id": "issue:firecrawl/firecrawl#1234",
      "passages": [
        {
          "text": "The client treats 429 as a terminal status, so the backoff never runs."
        }
      ],
      "title": "Retries are not applied to 429 responses",
      "type": "issue",
      "url": "https://github.com/firecrawl/firecrawl/issues/1234"
    }
  ],
  "success": true
}

GET

developer

Pesquise no índice para desenvolvedores

curl --request GET \
  --url https://api.firecrawl.dev/v2/search/developer \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.firecrawl.dev/v2/search/developer', 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/search/developer",
  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/search/developer"

	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/search/developer")

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

{
  "coverage": {
    "doc": "ok",
    "issue": "ok",
    "pull_request": "ok",
    "readme": "ok"
  },
  "reranked": true,
  "results": [
    {
      "id": "issue:firecrawl/firecrawl#1234",
      "passages": [
        {
          "text": "The client treats 429 as a terminal status, so the backoff never runs."
        }
      ],
      "title": "Retries are not applied to 429 responses",
      "type": "issue",
      "url": "https://github.com/firecrawl/firecrawl/issues/1234"
    }
  ],
  "success": true
}

Pesquise issues do GitHub, pull requests mesclados, READMEs de repositórios e sites de documentação selecionados. Os resultados são ranqueados e incluem as passagens correspondentes em Markdown. POST está disponível no mesmo caminho para passar filtros de array como JSON. Filtros repetíveis aceitam qualquer uma das formas em GET: um parâmetro de query repetido, como types=issue&types=pull_request, ou um valor separado por vírgulas, como types=issue,pull_request.

Como `repos` e `sources` restringem uma busca

O índice tem duas partes, e esses dois filtros restringem cada uma delas de forma independente:

repos restringe a parte do GitHub, ou seja, os tipos issue, pull_request e readme
sources restringe a parte da documentação, ou seja, o tipo doc
Informar ambos combina as duas partes, em vez de cruzá-las, para que você receba resultados correspondentes de qualquer uma delas

Como cada filtro se aplica a apenas uma parte, um filtro que não pode corresponder a nenhum tipo solicitado é rejeitado, em vez de não retornar resultados silenciosamente:

repos sem nenhum tipo do GitHub em types retorna 400 com repos cannot match any requested type; add github types or drop repos
sources sem doc em types retorna 400 com sources cannot match any requested type; add doc or drop sources

Como os filtros de repositório restringem uma busca

Os sete filtros de repositório — language (como Rust), topic (como async), license (como MIT), min_stars, max_stars, archived e fork — descrevem um repositório do GitHub. A maioria das páginas de documentação do índice vem de sites rastreados sem um repositório associado, e nenhum atributo de repositório pode incluir ou excluir essas páginas. Por isso, uma solicitação que envia um desses filtros sem especificar sources não retorna resultados doc. A resposta contém apenas evidências do GitHub: os tipos issue, pull_request e readme. O mapa coverage informa doc como unavailable, pois a parte da documentação do índice não foi consultada. Isso é intencional, não uma falha do índice. Para manter os resultados da documentação, remova os filtros de repositório. Você também pode restringir a parte da documentação com sources e consultar coverage para confirmar que o tipo doc retornou resultados.

# Não é necessária uma chave de API para começar; adicione -H "Authorization: Bearer $FIRECRAWL_API_KEY" para limites de taxa mais altos:
curl -s "https://api.firecrawl.dev/v2/search/developer?query=how%20do%20I%20configure%20retries&k=10&language=Rust&license=MIT"

curl -X POST https://api.firecrawl.dev/v2/search/developer \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "how do I configure retries",
    "k": 10,
    "types": ["issue", "pull_request"],
    "language": "Rust",
    "license": "MIT"
  }'

Quais valores `sources` aceita

sources não é um enum fixo. Aceita IDs de fontes de documentação, cada um uma string não vazia de até 512 caracteres, com no máximo 20 por solicitação. Os IDs correspondem aos sites de documentação presentes no índice, e esse conjunto cresce ao longo do tempo. Para confirmar que um ID é reconhecido, informe-o e verifique o array sources adicionado à resposta. Ele só aparece quando você envia sources e informa cada ID exatamente como foi solicitado, além de indicar se está indexado:

{
  "success": true,
  "results": [],
  "sources": [
    { "source": "some-docs-site", "indexed": true },
    { "source": "unknown-docs-site", "indexed": false }
  ]
}

indexed: true significa que a fonte tem uma geração publicada; portanto, evidências da documentação dela podem aparecer. indexed: false significa que nada desse id pode corresponder, o que diferencia um id que não está no índice de uma query que simplesmente não encontrou nada. repos também é retornado da mesma forma, como um array repos que informa indexed e apresenta uma divisão por tipo em types:

{
  "success": true,
  "results": [],
  "repos": [
    {
      "repo": "firecrawl/firecrawl",
      "indexed": true,
      "types": { "issue": true, "pullRequest": true, "readme": true }
    }
  ]
}

Como interpretar `coverage`

coverage informa o status de cada tipo de resultado: ok, degraded, unavailable ou skipped. Verifique-o quando um tipo de resultado esperado estiver ausente:

skipped significa que o valor de types não solicitou esse tipo
degraded ou unavailable significa que a lacuna veio do índice ou de um filtro, não da query. Um filtro de repositório é uma dessas causas, como explica a seção sobre como os filtros de repositório restringem uma busca

Para uma visão geral do fluxo de trabalho, consulte o guia do índice para desenvolvedores.

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de consulta

query

string

obrigatório

Pergunta em linguagem natural ou termo de busca.

Minimum string length: 1

integer

padrão:10

Número de resultados ranqueados a retornar.

Intervalo obrigatório: 1 <= x <= 100

types

enum<string>[]

Tipos de resultado a pesquisar. O padrão inclui os quatro tipos. Aceita um parâmetro repetido (types=issue&types=pull_request) ou um único valor separado por vírgulas (types=issue,pull_request).

Opções disponíveis:

doc,

issue,

pull_request,

readme

repos

string[]

Slugs de repositório para restringir a parte do índice referente ao GitHub, como firecrawl/firecrawl. Aplica-se apenas aos tipos issue, pull_request e readme. Quando enviados junto com sources, as duas partes são combinadas, e não cruzadas, portanto os resultados correspondentes podem vir de qualquer uma delas. Retorna 400 com repos cannot match any requested type; add github types or drop repos quando não há nenhum tipo do GitHub em types.

sources

string[]

IDs de fontes de documentação para restringir a parte da documentação a, no máximo, 20. Aplica-se apenas ao tipo doc. Não é uma enumeração fixa: os IDs refletem os sites de documentação no índice, e o conjunto cresce ao longo do tempo; portanto, confirme se um ID é válido enviando-o e consultando o array sources na resposta. Retorna 400 com sources cannot match any requested type; add doc or drop sources quando doc não está em types.

Maximum array length: 20

Required string length: 1 - 512

skills

enum<string>

Defina como only para limitar a busca a arquivos indexados de skill de agente.

Opções disponíveis:

only

passages

integer

padrão:1

Passagens correspondentes a retornar por resultado.

Intervalo obrigatório: 1 <= x <= 5

language

string

Linguagem principal do repositório, como Rust. Aplica-se apenas aos resultados do GitHub; enviá-lo sem restringir sources não retorna resultados de doc. Consulte como os filtros de repositório restringem uma busca.

Exemplo:

"Rust"

topic

string

Tópico do repositório, como async. Aplica-se apenas aos resultados do GitHub; enviá-lo sem restringir sources não retorna resultados de doc.

Exemplo:

"async"

license

string

Licença do repositório, como MIT. Aplica-se apenas aos resultados do GitHub; enviá-la sem restringir sources não retorna resultados de doc.

Exemplo:

"MIT"

min_stars

integer

Limite mínimo de estrelas do repositório. Aplica-se apenas aos resultados do GitHub; enviá-lo sem restringir sources não retorna resultados de doc.

Intervalo obrigatório: x >= 0

max_stars

integer

Limite máximo de estrelas do repositório. Aplica-se apenas aos resultados do GitHub; enviá-lo sem restringir sources não retorna resultados de doc.

Intervalo obrigatório: x >= 0

archived

boolean

Incluir ou excluir repositórios arquivados. Aplica-se apenas aos resultados do GitHub; enviá-lo sem restringir sources não retorna resultados de doc.

fork

boolean

Incluir ou excluir forks. Aplica-se apenas aos resultados do GitHub; enviá-lo sem restringir sources não retorna resultados de doc.

Resposta

Resultados para desenvolvedores ranqueados com passagens correspondentes.

coverage

object

Integridade do índice por tipo de resultado. Verifique isso quando um tipo de resultado esperado estiver ausente: skipped significa que o valor de types não solicitou esse tipo, enquanto degraded ou unavailable significa que a ausência se deve ao índice ou a um filtro, e não à consulta. Um filtro de repositório é uma dessas causas — veja como os filtros de repositório restringem uma busca.

Show child attributes

repos

object[]

Presente apenas quando repos é enviado. Retorna cada slug e indica se está indexado, além de uma divisão por tipo em types.

Show child attributes

Exemplo:

[
  {
    "indexed": true,
    "repo": "firecrawl/firecrawl",
    "types": {
      "issue": true,
      "pullRequest": true,
      "readme": true
    }
  }
]

reranked

boolean

Indica se a lista ranqueada passou pela etapa de reranqueamento.

results

object[]

Show child attributes

sources

object[]

Presente somente quando sources é enviado. Informa cada ID exatamente como solicitado, indicando se está indexado. indexed: true significa que a fonte tem uma geração publicada, portanto, evidências da documentação dela podem aparecer; indexed: false significa que nada desse ID pode corresponder, o que distingue um ID que não está no índice de uma query que simplesmente não encontrou nada.

Show child attributes

Exemplo:

[
  {
    "indexed": true,
    "source": "some-docs-site"
  },
  {
    "indexed": false,
    "source": "unknown-docs-site"
  }
]

success

boolean

Usando a API

Endpoints de busca

Endpoints /scrape

Endpoints de interação

Endpoints do Research Index

Endpoints do índice para desenvolvedores

Endpoints de mapeamento

Endpoints de análise

Endpoints de rastreamento

Endpoints de monitoramento

Endpoints de feedback

Endpoints de depuração agêntica

Endpoints da conta

Payloads de webhook

Integração de parceiro

Pesquise no índice para desenvolvedores

Como `repos` e `sources` restringem uma busca

Como os filtros de repositório restringem uma busca

Quais valores `sources` aceita

Como interpretar `coverage`

Autorizações

Parâmetros de consulta

Resposta

​Como repos e sources restringem uma busca

​Como os filtros de repositório restringem uma busca

​Quais valores sources aceita

​Como interpretar coverage

Autorizações

Parâmetros de consulta

Resposta

Como `repos` e `sources` restringem uma busca

Como os filtros de repositório restringem uma busca

Quais valores `sources` aceita

Como interpretar `coverage`