> ## Documentation Index
> Fetch the complete documentation index at: https://firecrawl-mog-monitoring-docs.mintlify.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> Faça uma busca na web, faça scraping de qualquer página e interaja com ela — tudo por meio de uma única API.

<Note>
  **Para agentes de IA:** Adicione `.md` a qualquer URL da documentação para obter o markdown, por exemplo
  [introduction.md](/pt-BR/introduction.md).
</Note>

<div id="get-started">
  ## Primeiros passos
</div>

<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 usar o Firecrawl
  </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>

As skills do Firecrawl são a forma mais rápida de os agentes descobrirem e usarem o Firecrawl. Sem elas, 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 as skills. Consulte [Skills + 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="what-can-firecrawl-do">
  ## O que o Firecrawl pode fazer?
</div>

<CardGroup cols={3}>
  <Card title="busca" icon="magnifying-glass" href="#search">
    Faça uma busca na web e obtenha o conteúdo completo da página a partir dos resultados
  </Card>

  <Card title="scraping" icon="file-lines" href="#scrape">
    Extraia conteúdo de qualquer URL como markdown, HTML ou JSON estruturado
  </Card>

  <Card title="interagir" icon="hand-pointer" href="#interact">
    Continue trabalhando com qualquer página obtida por scraping — clique, preencha formulários e extraia conteúdo dinâmico
  </Card>
</CardGroup>

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

* **Resultado pronto para LLM**: Markdown limpo, JSON estruturado, capturas de tela e muito mais.
* **Lida com o mais difícil**: Proxies, anti-bot, renderização de JavaScript e conteúdo dinâmico.
* **Confiável**: Projetado para produção, com alta disponibilidade e resultados consistentes.
* **Rápido**: Resultados em segundos, otimizado para alto throughput.
* **MCP Server**: Conecte o Firecrawl a qualquer ferramenta de IA via [Model Context Protocol](/pt-BR/mcp-server).

***

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

Faça uma busca na web e obtenha o conteúdo completo da página a partir dos resultados em uma única chamada. Consulte a [documentação do recurso de busca](/pt-BR/features/search) para ver todas as opções.

<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 cURL 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="scrape">
  ## Scraping
</div>

Faça scraping de qualquer URL e obtenha seu conteúdo em markdown, HTML ou outros formatos. Veja a [documentação do recurso de scraping](/pt-BR/features/scrape) para ver 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,
        "contentType": "text/html"
      }
    }
  }
  ```
</Accordion>

<div id="interact">
  ## Interagir
</div>

Faça o scraping de uma página e depois continue trabalhando com ela — clique em botões, preencha formulários, extraia conteúdo dinâmico ou navegue mais a fundo. Descreva o que você quer em inglês simples ou escreva código para ter controle total. Consulte a [documentação do recurso Interact](/pt-BR/features/interact) para ver todas as opções.

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

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

  # 1. Fazer scraping da página inicial da Amazon
  result = app.scrape("https://www.amazon.com", formats=["markdown"])
  scrape_id = result.metadata.scrape_id

  # 2. Interagir — buscar um produto e obter seu preço
  app.interact(scrape_id, prompt="Search for iPhone 16 Pro Max")
  response = app.interact(scrape_id, prompt="Click on the first result and tell me the price")
  print(response.output)

  # 3. Encerrar a sessão
  app.stop_interaction(scrape_id)
  ```

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

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

  // 1. Fazer scraping da página inicial da Amazon
  const result = await app.scrape('https://www.amazon.com', { formats: ['markdown'] });
  const scrapeId = result.metadata?.scrapeId;

  // 2. Interagir — buscar um produto e obter seu preço
  await app.interact(scrapeId, { prompt: 'Search for iPhone 16 Pro Max' });
  const response = await app.interact(scrapeId, { prompt: 'Click on the first result and tell me the price' });
  console.log(response.output);

  // 3. Encerrar a sessão
  await app.stopInteraction(scrapeId);
  ```

  ```bash cURL theme={null}
  # 1. Fazer scraping da página inicial da Amazon
  RESPONSE=$(curl -s -X POST "https://api.firecrawl.dev/v2/scrape" \
    -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"url": "https://www.amazon.com", "formats": ["markdown"]}')

  SCRAPE_ID=$(echo $RESPONSE | jq -r '.data.metadata.scrapeId')

  # 2. Interagir — buscar um produto e obter seu preço
  curl -s -X POST "https://api.firecrawl.dev/v2/scrape/$SCRAPE_ID/interact" \
    -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"prompt": "Search for iPhone 16 Pro Max"}'

  curl -s -X POST "https://api.firecrawl.dev/v2/scrape/$SCRAPE_ID/interact" \
    -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"prompt": "Click on the first result and tell me the price"}'

  # 3. Encerrar a sessão
  curl -s -X DELETE "https://api.firecrawl.dev/v2/scrape/$SCRAPE_ID/interact" \
    -H "Authorization: Bearer $FIRECRAWL_API_KEY"
  ```

  ```bash CLI theme={null}
  # 1. Faça scraping da página inicial da Amazon (o ID de scraping é salvo automaticamente)
  firecrawl scrape https://www.amazon.com

  # 2. Interaja — busque um produto e obtenha seu preço
  firecrawl interact "Search for iPhone 16 Pro Max"
  firecrawl interact "Click on the first result and tell me the price"

  # 3. Encerre a sessão
  firecrawl interact stop
  ```
</CodeGroup>

<Accordion title="Resposta">
  ```json Response theme={null}
  {
    "success": true,
    "liveViewUrl": "https://liveview.firecrawl.dev/...",
    "interactiveLiveViewUrl": "https://liveview.firecrawl.dev/...",
    "output": "The iPhone 16 Pro Max (256GB) is priced at $1,199.00.",
    "exitCode": 0,
    "killed": false
  }
  ```
</Accordion>

***

<div id="more-capabilities">
  ## Mais recursos
</div>

<CardGroup cols={4}>
  <Card title="Agent" icon="robot" href="/pt-BR/features/agent">
    Coleta autônoma de dados da web com IA
  </Card>

  <Card title="Browser Sandbox" icon="browser" href="/pt-BR/features/browser">
    Sessões de navegador gerenciadas para fluxos de trabalho interativos
  </Card>

  <Card title="Map" icon="map" href="/pt-BR/features/map">
    Descubra todas as URLs de um site
  </Card>

  <Card title="Crawl" icon="spider-web" href="/pt-BR/features/crawl">
    Colete conteúdo de sites inteiros de forma recursiva
  </Card>
</CardGroup>

***

<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>
