> ## Documentation Index
> Fetch the complete documentation index at: https://student-213fb9fc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Guia rápido

> O Firecrawl permite transformar sites inteiros em Markdown pronto para LLMs

<div id="scrape-your-first-website">
  ## Faça scraping do seu primeiro site
</div>

Transforme qualquer site em dados limpos, prontos para LLM, com uma única chamada de API.

<CardGroup cols={2}>
  <Card title="Obtenha sua chave de API" icon="key" href="https://www.firecrawl.dev/app/api-keys">
    Crie uma conta e obtenha sua chave de API para começar a fazer scraping
  </Card>

  <Card title="Experimente no Playground" icon="play" href="https://www.firecrawl.dev/playground">
    Teste a API instantaneamente, sem escrever nenhuma linha de código
  </Card>
</CardGroup>

<div id="use-firecrawl-with-ai-agents-recommended">
  ### Use o Firecrawl com agentes de IA (recomendado)
</div>

A skill do Firecrawl é a forma mais rápida de os agentes descobrirem e usarem o Firecrawl. Sem ela, seu agente não saberá que o Firecrawl está disponível.

```bash theme={null}
npx -y firecrawl-cli@latest init --all --browser
```

<Note>
  Reinicie o seu agente após instalar a skill. Consulte [Skill + CLI](/pt-BR/sdks/cli) para o guia completo de configuração.
</Note>

Ou use o [MCP Server](/pt-BR/mcp-server) para conectar o Firecrawl diretamente ao Claude, Cursor, Windsurf, VS Code e a outras ferramentas de IA.

<div id="make-your-first-request">
  ### Faça sua primeira requisição
</div>

Copie o código abaixo, substitua `fc-YOUR-API-KEY` pela sua chave de API e execute o comando:

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST 'https://api.firecrawl.dev/v2/scrape' \
    -H 'Authorization: Bearer fc-YOUR-API-KEY' \
    -H 'Content-Type: application/json' \
    -d '{"url": "https://example.com"}'
  ```

  ```python Python theme={null}
  # pip install firecrawl-py
  from firecrawl import Firecrawl

  app = Firecrawl(api_key="fc-YOUR-API-KEY")
  result = app.scrape("https://example.com")
  print(result)
  ```

  ```javascript Node theme={null}
  // npm install @mendable/firecrawl-js
  import Firecrawl from '@mendable/firecrawl-js';

  const app = new Firecrawl({ apiKey: "fc-YOUR-API-KEY" });
  const result = await app.scrape("https://example.com");
  console.log(result);
  ```

  ```bash CLI theme={null}
  firecrawl https://example.com
  ```
</CodeGroup>

<Accordion title="Exemplo de resposta">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples...",
      "metadata": {
        "title": "Example Domain",
        "sourceURL": "https://example.com"
      }
    }
  }
  ```
</Accordion>

***

<div id="what-can-firecrawl-do">
  ## O que o Firecrawl pode fazer?
</div>

<CardGroup cols={4}>
  <Card title="Scrape" icon="file-lines" href="#scraping">
    Extraia conteúdo de qualquer URL em Markdown, HTML ou JSON estruturado
  </Card>

  <Card title="Search" icon="magnifying-glass" href="#search">
    Busque na web e obtenha o conteúdo completo das páginas retornadas nos resultados
  </Card>

  <Card title="Agent" icon="robot" href="#agent">
    Coleta autônoma de dados da web com tecnologia de IA
  </Card>

  <Card title="Browser" icon="browser" href="/pt-BR/features/browser">
    Sessões de navegador seguras e em sandbox para fluxos de trabalho web interativos
  </Card>
</CardGroup>

<div id="why-firecrawl">
  ### Por que Firecrawl?
</div>

* **Saída pronta para LLMs**: Obtenha markdown limpo, JSON estruturado, capturas de tela e muito mais
* **Lida com as partes difíceis**: Proxies, anti-bot, renderização de JavaScript e conteúdo dinâmico
* **Confiável**: Feito para produção, com alta disponibilidade e resultados consistentes
* **Rápido**: Obtenha resultados em segundos, otimizado para alto volume de requisições
* **Sandbox de navegador**: Ambientes de navegador totalmente gerenciados para agentes, zero configuração, escala para qualquer volume
* **MCP Server**: Conecte o Firecrawl a qualquer ferramenta de IA via o [Model Context Protocol](/pt-BR/mcp-server)

***

<div id="scraping">
  ## Extração
</div>

Extraia qualquer URL e obtenha seu conteúdo em markdown, HTML ou outros formatos. Veja a [documentação do recurso de Extração](/pt-BR/features/scrape) para todas as opções.

<CodeGroup>
  ```python Python theme={null}
  from firecrawl import Firecrawl

  firecrawl = Firecrawl(api_key="fc-YOUR-API-KEY")

  # Raspar um site:
  doc = firecrawl.scrape("https://firecrawl.dev", formats=["markdown", "html"])
  print(doc)
  ```

  ```js Node theme={null}
  import Firecrawl from '@mendable/firecrawl-js';

  const firecrawl = new Firecrawl({ apiKey: "fc-YOUR-API-KEY" });

  // Fazer a raspagem de um site:
  const doc = await firecrawl.scrape('https://firecrawl.dev', { formats: ['markdown', 'html'] });
  console.log(doc);
  ```

  ```bash cURL theme={null}
  curl -s -X POST "https://api.firecrawl.dev/v2/scrape" \
    -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "url": "https://firecrawl.dev",
      "formats": ["markdown", "html"]
    }'
  ```

  ```bash CLI theme={null}
  # Scrape a URL and get markdown
  firecrawl https://firecrawl.dev

  # Com múltiplos formatos (retorna JSON)
  firecrawl https://firecrawl.dev --format markdown,html,links --pretty
  ```
</CodeGroup>

<Accordion title="Resposta">
  Os SDKs retornarão o objeto de dados diretamente. O cURL retornará o payload exatamente como mostrado abaixo.

  ```json theme={null}
  {
    "success": true,
    "data" : {
      "markdown": "A Launch Week I chegou! [Confira nosso lançamento do Dia 2 🚀](https://www.firecrawl.dev/blog/launch-week-i-day-2-doubled-rate-limits)[💥 Ganhe 2 meses grátis...",
      "html": "<!DOCTYPE html><html lang=\"en\" class=\"light\" style=\"color-scheme: light;\"><body class=\"__variable_36bd41 __variable_d7dc5d font-inter ...",
      "metadata": {
        "title": "Home - Firecrawl",
        "description": "O Firecrawl rastreia e converte qualquer site em markdown limpo.",
        "language": "en",
        "keywords": "Firecrawl,Markdown,Dados,Mendable,Langchain",
        "robots": "follow, index",
        "ogTitle": "Firecrawl",
        "ogDescription": "Transforme qualquer site em dados prontos para LLM.",
        "ogUrl": "https://www.firecrawl.dev/",
        "ogImage": "https://www.firecrawl.dev/og.png?123",
        "ogLocaleAlternate": [],
        "ogSiteName": "Firecrawl",
        "sourceURL": "https://firecrawl.dev",
        "statusCode": 200
      }
    }
  }
  ```
</Accordion>

<div id="search">
  ## Busca
</div>

A API de busca do Firecrawl permite realizar pesquisas na web e, opcionalmente, extrair (scrape) os resultados em uma única operação.

* Escolha formatos de saída específicos (Markdown, HTML, links, capturas de tela)
* Escolha fontes específicas (web, notícias, imagens)
* Pesquise na web com parâmetros personalizáveis (localização, etc.)

Para mais detalhes, consulte a [referência da API do endpoint /search](/pt-BR/api-reference/endpoint/search).

<CodeGroup>
  ```python Python theme={null}
  from firecrawl import Firecrawl

  firecrawl = Firecrawl(api_key="fc-SUA-API-KEY")

  results = firecrawl.search(
      query="firecrawl",
      limit=3,
  )
  print(results)
  ```

  ```js Node theme={null}
  import Firecrawl from '@mendable/firecrawl-js';

  const firecrawl = new Firecrawl({ apiKey: "fc-SUA-API-KEY" });

  const results = await firecrawl.search('firecrawl', {
    limit: 3,
    scrapeOptions: { formats: ['markdown'] }
  });
  console.log(results);
  ```

  ```bash theme={null}
  curl -s -X POST "https://api.firecrawl.dev/v2/search" \
    -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "query": "firecrawl",
      "limit": 3
    }'
  ```

  ```bash CLI theme={null}
  # Buscar na web
  firecrawl search "firecrawl web scraping" --limit 5 --pretty
  ```
</CodeGroup>

<Accordion title="Resposta">
  Os SDKs retornarão diretamente o objeto de dados. O cURL retornará o payload completo.

  ```json JSON theme={null}
  {
    "success": true,
    "data": {
      "web": [
        {
          "url": "https://www.firecrawl.dev/",
          "title": "Firecrawl - The Web Data API for AI",
          "description": "The web crawling, scraping, and search API for AI. Built for scale. Firecrawl delivers the entire internet to AI agents and builders.",
          "position": 1
        },
        {
          "url": "https://github.com/firecrawl/firecrawl",
          "title": "mendableai/firecrawl: Turn entire websites into LLM-ready ... - GitHub",
          "description": "Firecrawl is an API service that takes a URL, crawls it, and converts it into clean markdown or structured data.",
          "position": 2
        },
        ...
      ],
      "images": [
        {
          "title": "Quickstart | Firecrawl",
          "imageUrl": "https://mintlify.s3.us-west-1.amazonaws.com/firecrawl/logo/logo.png",
          "imageWidth": 5814,
          "imageHeight": 1200,
          "url": "https://docs.firecrawl.dev/",
          "position": 1
        },
        ...
      ],
      "news": [
        {
          "title": "Y Combinator startup Firecrawl is ready to pay $1M to hire three AI agents as employees",
          "url": "https://techcrunch.com/2025/05/17/y-combinator-startup-firecrawl-is-ready-to-pay-1m-to-hire-three-ai-agents-as-employees/",
          "snippet": "It's now placed three new ads on YC's job board for “AI agents only” and has set aside a $1 million budget total to make it happen.",
          "date": "3 months ago",
          "position": 1
        },
        ...
      ]
    }
  }
  ```
</Accordion>

<div id="agent">
  ## Agent
</div>

O Agent do Firecrawl é uma ferramenta autônoma de coleta de dados na web. Basta descrever quais dados você precisa e ele vai pesquisar, navegar e extrair esses dados de qualquer lugar na web. Veja a [documentação do recurso Agent](/pt-BR/features/agent) para ver todas as opções.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST 'https://api.firecrawl.dev/v2/agent' \
    -H 'Authorization: Bearer fc-YOUR-API-KEY' \
    -H 'Content-Type: application/json' \
    -d '{
      "prompt": "Find the pricing plans for Notion"
    }'
  ```

  ```python Python theme={null}
  from firecrawl import Firecrawl

  app = Firecrawl(api_key="fc-YOUR-API-KEY")
  result = app.agent("Find the pricing plans for Notion")
  print(result)
  ```

  ```javascript Node theme={null}
  import Firecrawl from '@mendable/firecrawl-js';

  const app = new Firecrawl({ apiKey: "fc-YOUR-API-KEY" });
  const result = await app.agent("Find the pricing plans for Notion");
  console.log(result);
  ```
</CodeGroup>

<Accordion title="Exemplo de resposta">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "result": "O Notion oferece os seguintes planos de preços:\n\n1. **Free** - US$0/mês - Para indivíduos...\n2. **Plus** - US$10/usuário/mês - Para pequenas equipes...\n3. **Business** - US$18/usuário/mês - Para empresas...\n4. **Enterprise** - Preço personalizado - Para grandes organizações...",
      "sources": [
        "https://www.notion.so/pricing"
      ]
    }
  }
  ```
</Accordion>

***

<div id="resources">
  ## Recursos
</div>

<CardGroup cols={2}>
  <Card title="Referência da API" icon="code" href="/pt-BR/api-reference/v2-introduction">
    Documentação completa da API com exemplos interativos
  </Card>

  <Card title="SDKs" icon="boxes-stacked" href="/pt-BR/sdks/overview">
    SDKs para Python, Node.js, CLI e da comunidade
  </Card>

  <Card title="Open Source" icon="github" href="/pt-BR/contributing/open-source-or-cloud">
    Hospede o Firecrawl na sua própria infraestrutura ou contribua com o projeto
  </Card>

  <Card title="Integrações" icon="puzzle-piece" href="/pt-BR/developer-guides/llm-sdks-and-frameworks/openai">
    LangChain, LlamaIndex, OpenAI e mais
  </Card>
</CardGroup>