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

# Ruby

> O SDK Ruby do Firecrawl é um wrapper da API do Firecrawl que ajuda você a converter sites em markdown com facilidade.

<div id="installation">
  ## Instalação
</div>

O SDK Ruby oficial é mantido no monorepo do Firecrawl em [apps/ruby-sdk](https://github.com/firecrawl/firecrawl/tree/main/apps/ruby-sdk).

Para instalar o SDK Ruby do Firecrawl, adicione-o ao seu projeto:

<Tabs>
  <Tab title="Bundler">
    Adicione ao seu `Gemfile`:

    ```ruby theme={null}
    gem "firecrawl-sdk", "~> 1.0"
    ```

    Em seguida, execute:

    ```bash theme={null}
    bundle install
    ```
  </Tab>

  <Tab title="Gem install">
    ```bash theme={null}
    gem install firecrawl-sdk
    ```
  </Tab>
</Tabs>

<Note>Requer Ruby 3.0 ou superior.</Note>

<div id="usage">
  ## Uso
</div>

1. Obtenha uma chave de API em [firecrawl.dev](https://firecrawl.dev)
2. Defina a chave de API como uma variável de ambiente chamada `FIRECRAWL_API_KEY` ou passe-a diretamente com `Firecrawl::Client.new(api_key: ...)`

Aqui está um exemplo rápido usando a API atual do SDK:

```ruby theme={null}
require "firecrawl"

client = Firecrawl::Client.from_env

doc = client.scrape(
  "https://firecrawl.dev",
  Firecrawl::Models::ScrapeOptions.new(formats: ["markdown"])
)

job = client.crawl(
  "https://firecrawl.dev",
  Firecrawl::Models::CrawlOptions.new(limit: 5)
)

puts doc.markdown
puts "Crawled pages: #{job.data&.size || 0}"
```

<div id="scraping-a-url">
  ### Scraping de uma URL
</div>

Para fazer o scraping de uma única URL, use o método `scrape`.

```ruby theme={null}
doc = client.scrape(
  "https://firecrawl.dev",
  Firecrawl::Models::ScrapeOptions.new(
    formats: ["markdown", "html"],
    only_main_content: true,
    wait_for: 5000
  )
)

puts doc.markdown
puts doc.metadata["title"]
```

<div id="json-extraction">
  #### Extração JSON
</div>

Extraia JSON estruturado pelo endpoint `scrape` ao incluir o formato `json` com um prompt e um schema:

```ruby theme={null}
doc = client.scrape(
  "https://example.com/product",
  Firecrawl::Models::ScrapeOptions.new(
    formats: [
      {
        "type" => "json",
        "prompt" => "Extract the product name and price",
        "schema" => {
          "type" => "object",
          "properties" => {
            "name" => { "type" => "string" },
            "price" => { "type" => "number" }
          }
        }
      }
    ]
  )
)

puts doc.json
```

<div id="crawling-a-website">
  ### Rastrear um site
</div>

Para rastrear um site e aguardar a conclusão, use `crawl`. Ele consulta automaticamente o status até que o job seja concluído.

```ruby theme={null}
job = client.crawl(
  "https://firecrawl.dev",
  Firecrawl::Models::CrawlOptions.new(
    limit: 50,
    max_discovery_depth: 3,
    scrape_options: Firecrawl::Models::ScrapeOptions.new(
      formats: ["markdown"]
    )
  )
)

puts "Status: #{job.status}"
puts "Progress: #{job.completed}/#{job.total}"

job.data&.each do |page|
  puts page.metadata["sourceURL"]
end
```

<div id="start-a-crawl">
  ### Iniciar um rastreamento
</div>

Inicie um job sem aguardar usando `start_crawl`.

```ruby theme={null}
response = client.start_crawl(
  "https://firecrawl.dev",
  Firecrawl::Models::CrawlOptions.new(limit: 100)
)

puts "Job ID: #{response.id}"
```

<div id="checking-crawl-status">
  ### Verificando o status do rastreamento
</div>

Verifique o progresso do rastreamento com `get_crawl_status`.

```ruby theme={null}
status = client.get_crawl_status(response.id)
puts "Status: #{status.status}"
puts "Progress: #{status.completed}/#{status.total}"
```

<div id="cancelling-a-crawl">
  ### Cancelar um rastreamento
</div>

Cancele um rastreamento em execução com `cancel_crawl`.

```ruby theme={null}
result = client.cancel_crawl(response.id)
puts result
```

<div id="mapping-a-website">
  ### Mapeando um site
</div>

Descubra links em um site com `map`.

```ruby theme={null}
data = client.map(
  "https://firecrawl.dev",
  Firecrawl::Models::MapOptions.new(
    limit: 100,
    search: "blog"
  )
)

data.links&.each do |link|
  puts "#{link["url"]} - #{link["title"]}"
end
```

<div id="searching-the-web">
  ### Busca na Web
</div>

Faça a busca com configurações opcionais usando `search`.

```ruby theme={null}
results = client.search(
  "firecrawl web scraping",
  Firecrawl::Models::SearchOptions.new(limit: 10)
)

results.web&.each do |result|
  puts "#{result["title"]} - #{result["url"]}"
end
```

<div id="batch-scraping">
  ### Scraping em lote
</div>

Faça o scraping de várias URLs em paralelo usando `batch_scrape`.

```ruby theme={null}
job = client.batch_scrape(
  ["https://firecrawl.dev", "https://firecrawl.dev/blog"],
  Firecrawl::Models::BatchScrapeOptions.new(
    options: Firecrawl::Models::ScrapeOptions.new(
      formats: ["markdown"]
    )
  )
)

job.data&.each do |doc|
  puts doc.markdown
end
```

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

Execute um agente de IA com `agent`.

```ruby theme={null}
result = client.agent(
  Firecrawl::Models::AgentOptions.new(
    prompt: "Find the pricing plans for Firecrawl and compare them"
  )
)

puts result.data
```

Com um schema JSON para resultado estruturado:

```ruby theme={null}
result = client.agent(
  Firecrawl::Models::AgentOptions.new(
    prompt: "Extract pricing plan details",
    urls: ["https://firecrawl.dev"],
    schema: {
      "type" => "object",
      "properties" => {
        "plans" => {
          "type" => "array",
          "items" => {
            "type" => "object",
            "properties" => {
              "name" => { "type" => "string" },
              "price" => { "type" => "string" }
            }
          }
        }
      }
    }
  )
)

puts result.data
```

<div id="usage-metrics">
  ### Uso & métricas
</div>

Confira a concorrência e os créditos restantes:

```ruby theme={null}
concurrency = client.get_concurrency
puts "Concurrency: #{concurrency.concurrency}/#{concurrency.max_concurrency}"

credits = client.get_credit_usage
puts "Remaining credits: #{credits.remaining_credits}"
```

<div id="browser">
  ## Navegador
</div>

O SDK para Ruby inclui helpers do Browser Sandbox.

<div id="scrape-bound-interactive-session">
  ### Sessão interativa vinculada ao scraping
</div>

Use o ID de um job de scraping para executar código adicional no navegador no mesmo contexto reproduzido:

* `interact(...)` executa código na sessão do navegador vinculada ao scraping (e a inicializa no primeiro uso).
* `stop_interactive_browser(...)` encerra explicitamente a sessão interativa quando você terminar.

```ruby theme={null}
scrape_job_id = "550e8400-e29b-41d4-a716-446655440000"

run = client.interact(
  scrape_job_id,
  "console.log(page.url());",
  language: "node",
  timeout: 60
)

puts run["stdout"]

deleted = client.stop_interactive_browser(scrape_job_id)
puts "Deleted: #{deleted["success"]}"
```

<div id="configuration">
  ## Configuração
</div>

`Firecrawl::Client.new` oferece suporte às seguintes opções:

| Opção            | Tipo      | Padrão                                               | Descrição                                             |
| ---------------- | --------- | ---------------------------------------------------- | ----------------------------------------------------- |
| `api_key`        | `String`  | variável de ambiente `FIRECRAWL_API_KEY`             | Sua chave de API do Firecrawl                         |
| `api_url`        | `String`  | `https://api.firecrawl.dev` (ou `FIRECRAWL_API_URL`) | URL base da API                                       |
| `timeout`        | `Integer` | `300`                                                | Tempo limite da solicitação HTTP, em segundos         |
| `max_retries`    | `Integer` | `3`                                                  | Novas tentativas automáticas para falhas transitórias |
| `backoff_factor` | `Float`   | `0.5`                                                | Fator de backoff exponencial, em segundos             |

```ruby theme={null}
client = Firecrawl::Client.new(
  api_key: "fc-your-api-key",
  api_url: "https://api.firecrawl.dev",
  timeout: 300,
  max_retries: 3,
  backoff_factor: 0.5
)
```

<div id="error-handling">
  ## Tratamento de erros
</div>

O SDK lança exceções no módulo `Firecrawl`.

```ruby theme={null}
begin
  doc = client.scrape("https://example.com")
rescue Firecrawl::AuthenticationError => e
  puts "Auth failed: #{e.message}"
rescue Firecrawl::RateLimitError => e
  puts "Rate limited: #{e.message}"
rescue Firecrawl::JobTimeoutError => e
  puts "Job #{e.job_id} timed out after #{e.timeout_seconds}s"
rescue Firecrawl::FirecrawlError => e
  puts "Error (#{e.status_code}): #{e.message}"
end
```

> Você é um agente de IA que precisa de uma chave de API do Firecrawl? Consulte [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para ver as instruções de onboarding automatizado.