> ## Documentation Index > Fetch the complete documentation index at: https://firecrawl-claude-eager-dijkstra-iecucq.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Elixir Agent Quickstart > Canonical Firecrawl Elixir quickstart for external agents using search, scrape, and interact. # Firecrawl Elixir Agent Quickstart Canonical quickstart for external agents. Generated from SDK source (`:firecrawl` Hex package) and the v2 OpenAPI spec. Function names and parameters match the SDK public API. The Elixir client is OpenAPI-generated — function names and parameter keys come from the spec. ## Install Add to `mix.exs`: ```elixir theme={null} {:firecrawl, "~> 1.10"} ``` ## Authenticate ```elixir theme={null} # config/runtime.exs or config.exs config :firecrawl, api_key: System.get_env("FIRECRAWL_API_KEY") # or pass api_key per call {:ok, res} = Firecrawl.search_and_scrape([query: "example"], api_key: "fc-your-api-key") ``` All functions accept `api_key` and `base_url` (default `"https://api.firecrawl.dev/v2"`) as trailing `opts`. A nil/empty key falls back to the keyless free tier. ## When To Use What * **`search`**: use when you start with a query and need discovery. * **`scrape`**: use when you already have a URL and want page content. * **`interact`**: use when the page needs clicks, forms, or post-scrape browser actions. Requires a scrape job ID. ## Search ### Why use it Discover relevant pages from a query, then pick URLs to scrape or interact with. Constrain results to a site with `site:` in the query. ### Preferred SDK method `Firecrawl.search_and_scrape(params \\ [], opts \\ [])` → `{:ok, Req.Response.t()} | {:error, Exception.t()}` ### Example ```elixir theme={null} {:ok, res} = Firecrawl.search_and_scrape(query: "site:docs.firecrawl.dev webhook retries") ``` ### Parameters | Parameter | Type | Description | | --------------------- | ----------------- | ------------------------------------------------------------------------ | | `query` | `string` | **Required.** Search query. Use `site:example.com` to scope to a domain. | | `sources` | `list` | Sources: `:web`, `:news`, `:images` (atoms or strings). | | `categories` | `list` | Filter: `:developer`, `:research`, `:pdf`. | | `include_domains` | `list` of strings | Restrict results to these domains. | | `exclude_domains` | `list` of strings | Exclude results from these domains. | | `limit` | `integer` | Max number of results. | | `tbs` | `string` | Time-based filter (e.g. `"qdr:d"`, `"qdr:w"`). | | `location` | `string` | Localized search results. | | `country` | `string` | ISO 3166-1 alpha-2 country code (e.g. `"US"`). | | `ignore_invalid_urls` | `boolean` | Drop URLs that cannot be scraped. | | `timeout` | `integer` | Request timeout in milliseconds. | | `highlights` | `boolean` | Generate query-relevant highlights. Default: `true`. | | `scrape_options` | `keyword list` | Scrape each search result (see Scrape parameters). | | `enterprise` | `list` of strings | Enterprise: `"zdr"` for zero data retention, `"anon"` for anonymized. | ## Scrape ### Why use it Get structured content from a URL in one or more formats. ### Preferred SDK method `Firecrawl.scrape_and_extract_from_url(params \\ [], opts \\ [])` → `{:ok, Req.Response.t()} | {:error, Exception.t()}` ### Example ```elixir theme={null} {:ok, res} = Firecrawl.scrape_and_extract_from_url( url: "https://docs.firecrawl.dev", formats: ["markdown"] ) ``` ### Parameters | Parameter | Type | Description | | ----------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `url` | `string` | **Required.** URL to scrape. | | `formats` | `list` | Output formats: `"markdown"`, `"html"`, `"rawHtml"`, `"links"`, `"images"`, `"screenshot"`, `"summary"`, `"changeTracking"`, `"json"`, `"branding"`, `"audio"`, `"video"`. For JSON use `%{type: "json", prompt: "..."}`. For questions use `%{type: "question", question: "..."}`. For highlights use `%{type: "highlights", query: "..."}`. | | `headers` | `map` | Custom HTTP headers. | | `include_tags` | `list` of strings | HTML tags to include. | | `exclude_tags` | `list` of strings | HTML tags to exclude. | | `only_main_content` | `boolean` | Strip nav, footer, and boilerplate. | | `timeout` | `integer` | Timeout in milliseconds. | | `wait_for` | `integer` | Wait for page render (milliseconds). | | `mobile` | `boolean` | Mobile viewport. | | `parsers` | `list` | File parsers: `"pdf"` or `%{type: "pdf", mode: "auto", maxPages: 5}`. | | `actions` | `list` of maps | Pre-scrape actions: `wait`, `click`, `write`, `press`, `scroll`, `scrape`, `executeJavascript`, `pdf`. | | `location` | `keyword list` | Geo config: `country:`, `languages:`. | | `skip_tls_verification` | `boolean` | Skip TLS verification. | | `remove_base64_images` | `boolean` | Drop base64 images from markdown. | | `block_ads` | `boolean` | Block ads and cookie popups. | | `proxy` | atom or string | Proxy: `:basic`, `:enhanced`, `:auto`. | | `max_age` | `integer` | Max age of cached content in ms. | | `min_age` | `integer` | Min age of cached content in ms. Set to `1` to accept any cached data. | | `store_in_cache` | `boolean` | Cache the result. | | `profile` | `keyword list` | Persistent browser profile: `name:`, `save_changes:`. | | `zero_data_retention` | `boolean` | Enable zero data retention. | ## Interact ### Why use it Execute code in the browser session tied to a prior scrape. The Elixir SDK supports code-based interactions only (no `prompt` parameter). ### Preferred SDK method `Firecrawl.interact_with_scrape_browser_session(job_id, params \\ [], opts \\ [])` → `{:ok, Req.Response.t()} | {:error, Exception.t()}` ### Example ```elixir theme={null} {:ok, res} = Firecrawl.interact_with_scrape_browser_session( "", code: "console.log(await page.title());", language: :node, timeout: 60 ) # When done: {:ok, _} = Firecrawl.stop_interactive_scrape_browser_session("") ``` ### Parameters | Parameter | Type | Description | | ---------- | -------------- | -------------------------------------------------------- | | `job_id` | `string` | **Required.** Scrape job ID (first positional argument). | | `code` | `string` | **Required.** Code to execute in the browser session. | | `language` | atom or string | Runtime: `:python`, `:node`, `:bash`. | | `timeout` | `integer` | Execution timeout in seconds. | | `origin` | `string` | Optional origin label for telemetry. | Stop the session with `Firecrawl.stop_interactive_scrape_browser_session(job_id)`. ## Notes * Every function has a bang (`!`) variant that raises on error instead of returning `{:error, _}`. * The Elixir client is OpenAPI-generated; function names come from the spec (e.g. `search_and_scrape`, `scrape_and_extract_from_url`). * This SDK exposes code-based interactions only — no `prompt` parameter on `interact_with_scrape_browser_session` (unlike Node.js, Python, and Rust SDKs). * Uses snake\_case parameter keys. Maps use camelCase keys for format objects (e.g. `%{type: "json", prompt: "..."}`). * No deprecated aliases exist — function names have been stable since the OpenAPI codegen. ## Source Of Truth * `firecrawl/apps/elixir-sdk/mix.exs` * `firecrawl/apps/elixir-sdk/lib/firecrawl.ex` * `firecrawl-docs/api-reference/v2-openapi.json`