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

# Elixir

> 开始在 Elixir 中使用 Firecrawl。通过官方 SDK 搜索、抓取并与网页数据交互。

<div id="prerequisites">
  ## 前置条件
</div>

* Elixir 1.14+ 和 OTP 25+
* 一个 Firecrawl API 密钥——[免费获取](https://www.firecrawl.dev/app/api-keys)

<div id="install-the-sdk">
  ## 安装 SDK
</div>

将 `firecrawl` 添加到 `mix.exs` 中：

```elixir theme={null}
defp deps do
  [
    {:firecrawl, "~> 1.0"}
  ]
end
```

在 `config/config.exs` 中配置您的 API 密钥：

```elixir theme={null}
config :firecrawl, api_key: System.get_env("FIRECRAWL_API_KEY")
```

<div id="search-the-web">
  ## 进行网页搜索
</div>

```elixir theme={null}
{:ok, result} = Firecrawl.search_and_scrape(query: "firecrawl web scraping", limit: 5)

for entry <- result.body["data"]["web"] do
  IO.puts("#{entry["title"]} - #{entry["url"]}")
end
```

<div id="scrape-a-page">
  ## 抓取网页
</div>

```elixir theme={null}
{:ok, result} = Firecrawl.scrape_and_extract_from_url(url: "https://example.com")
IO.puts(result.body["data"]["markdown"])
```

<Accordion title="示例响应">
  ```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="interact-with-a-page">
  ## 与页面交互
</div>

先抓取页面，再通过浏览器会话 API 继续与其交互。

```elixir theme={null}
{:ok, scrape} = Firecrawl.scrape_and_extract_from_url(
  url: "https://www.amazon.com",
  formats: ["markdown"]
)

scrape_id = get_in(scrape.body, ["data", "metadata", "scrapeId"])

# 使用 REST API 进行交互（基于 prompt）
headers = [
  {"Authorization", "Bearer #{Application.get_env(:firecrawl, :api_key)}"},
  {"Content-Type", "application/json"}
]

{:ok, _} = Req.post(
  "https://api.firecrawl.dev/v2/scrape/#{scrape_id}/interact",
  json: %{prompt: "Search for iPhone 16 Pro Max"},
  headers: headers
)

{:ok, response} = Req.post(
  "https://api.firecrawl.dev/v2/scrape/#{scrape_id}/interact",
  json: %{prompt: "Click on the first result and tell me the price"},
  headers: headers
)

IO.inspect(response.body)

# 停止会话
Req.delete(
  "https://api.firecrawl.dev/v2/scrape/#{scrape_id}/interact",
  headers: headers
)
```

<div id="environment-variable">
  ## 环境变量
</div>

请设置 `FIRECRAWL_API_KEY`，不要将其硬编码：

```bash theme={null}
export FIRECRAWL_API_KEY=fc-YOUR-API-KEY
```

<div id="next-steps">
  ## 下一步
</div>

<CardGroup cols={2}>
  <Card title="抓取 文档" icon="file-lines" href="/zh/features/scrape">
    涵盖所有 scrape 选项，包括 formats、actions 和代理
  </Card>

  <Card title="搜索 文档" icon="magnifying-glass" href="/zh/features/search">
    进行网页搜索并获取完整页面内容
  </Card>

  <Card title="交互文档" icon="hand-pointer" href="/zh/features/interact">
    点击、填写表单并提取动态内容
  </Card>

  <Card title="Elixir SDK 参考" icon="droplet" href="/zh/sdks/elixir">
    完整的 SDK 参考，涵盖爬取、map、batch scrape 等
  </Card>
</CardGroup>
