@spec ask_support_agent(keyword(), keyword()) :: response()

Ask the Firecrawl support agent

POST /support/ask

Tag: Support

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @ask_support_agent_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec ask_support_agent!(keyword(), keyword()) :: Req.Response.t()

Bang variant of ask_support_agent. Raises on error.

@spec cancel_agent(
  String.t(),
  keyword()
) :: response()

Cancel an agent job

DELETE /agent/{jobId}

Tag: Agent

Path Parameters

• job_id - Path parameter jobId

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec cancel_agent!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of cancel_agent. Raises on error.

@spec cancel_batch_scrape(
  String.t(),
  keyword()
) :: response()

Cancel a batch scrape job

DELETE /batch/scrape/{id}

Tag: Scraping

Path Parameters

• id - Path parameter id

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec cancel_batch_scrape!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of cancel_batch_scrape. Raises on error.

@spec cancel_crawl(
  String.t(),
  keyword()
) :: response()

Cancel a crawl job

DELETE /crawl/{id}

Tag: Crawling

Path Parameters

• id - Path parameter id

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec cancel_crawl!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of cancel_crawl. Raises on error.

@spec crawl_params_preview(keyword(), keyword()) :: response()

Preview crawl parameters generated from natural language prompt

POST /crawl/params-preview

Tag: Crawling

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @crawl_params_preview_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec crawl_params_preview!(keyword(), keyword()) :: Req.Response.t()

Bang variant of crawl_params_preview. Raises on error.

@spec crawl_urls(keyword(), keyword()) :: response()

Crawl multiple URLs based on options

POST /crawl

Tag: Crawling

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @crawl_urls_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec crawl_urls!(keyword(), keyword()) :: Req.Response.t()

Bang variant of crawl_urls. Raises on error.

@spec create_browser_session(keyword(), keyword()) :: response()

Create an interact session

POST /interact

Tag: Interact

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @create_browser_session_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec create_browser_session!(keyword(), keyword()) :: Req.Response.t()

Bang variant of create_browser_session. Raises on error.

@spec create_monitor(keyword(), keyword()) :: response()

Create a scheduled monitor.

POST /monitor

Targets

targets is a list of maps/keyword lists. Each target is sent as-is (keys are camelCased), so the supported target shapes are:

• Scrape: [type: "scrape", url: "https://example.com", ...]
• Crawl: [type: "crawl", url: "https://example.com", ...]
• Search: [type: "search", queries: ["term"], search_window: "24h", include_domains: ["example.com"], exclude_domains: [], max_results: 10] (search_window is one of "5m", "15m", "1h", "6h", "24h", "7d"; only queries is required.)

Optionally pass goal and judge_enabled: true to enable AI judging.

@spec create_monitor!(keyword(), keyword()) :: Req.Response.t()

Bang variant of create_monitor. Raises on error.

@spec delete_browser_session(
  String.t(),
  keyword()
) :: response()

Delete an interact session

DELETE /interact/{sessionId}

Tag: Interact

Path Parameters

• session_id - Path parameter sessionId

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec delete_browser_session!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of delete_browser_session. Raises on error.

@spec delete_monitor(
  String.t(),
  keyword()
) :: response()

Delete a monitor.

DELETE /monitor/{monitorId}

@spec delete_monitor!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of delete_monitor. Raises on error.

@spec developer_search(keyword(), keyword()) :: response()

Search the developer index

GET /search/developer

Tag: Developer

Query Parameters

• query — query parameter query
• k — query parameter k
• types — query parameter types
• repos — query parameter repos
• sources — query parameter sources
• skills — query parameter skills
• passages — query parameter passages
• language — query parameter language
• topic — query parameter topic
• license — query parameter license
• min_stars — query parameter min_stars
• max_stars — query parameter max_stars
• archived — query parameter archived
• fork — query parameter fork

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec developer_search!(keyword(), keyword()) :: Req.Response.t()

Bang variant of developer_search. Raises on error.

@spec developer_search_post(keyword(), keyword()) :: response()

Search the developer index

POST /search/developer

Tag: Developer

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @developer_search_post_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec developer_search_post!(keyword(), keyword()) :: Req.Response.t()

Bang variant of developer_search_post. Raises on error.

@spec execute_browser_code(String.t(), keyword(), keyword()) :: response()

Execute code in an interact session

POST /interact/{sessionId}/execute

Tag: Interact

Path Parameters

• session_id - Path parameter sessionId

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @execute_browser_code_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec execute_browser_code!(String.t(), keyword(), keyword()) :: Req.Response.t()

Bang variant of execute_browser_code. Raises on error.

@spec get_active_crawls(keyword()) :: response()

Get all active crawls for the authenticated team

GET /crawl/active

Tag: Crawling

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_active_crawls!(keyword()) :: Req.Response.t()

Bang variant of get_active_crawls. Raises on error.

@spec get_activity(keyword(), keyword()) :: response()

List recent API activity

GET /team/activity

Tag: Account

Query Parameters

• endpoint — query parameter endpoint
• limit — query parameter limit
• cursor — query parameter cursor

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_activity!(keyword(), keyword()) :: Req.Response.t()

Bang variant of get_activity. Raises on error.

@spec get_agent_snapshot(String.t(), String.t(), keyword()) :: response()

Get an output snapshot of an agent job

GET /agent/{jobId}/snapshots/{snapshotId}

Tag: Agent

Path Parameters

• job_id - Path parameter jobId
• snapshot_id - Path parameter snapshotId

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_agent_snapshot!(String.t(), String.t(), keyword()) :: Req.Response.t()

Bang variant of get_agent_snapshot. Raises on error.

@spec get_agent_status(
  String.t(),
  keyword()
) :: response()

Get the status of an agent job

GET /agent/{jobId}

Tag: Agent

Path Parameters

• job_id - Path parameter jobId

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_agent_status!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of get_agent_status. Raises on error.

@spec get_agent_trace(
  String.t(),
  keyword()
) :: response()

Get the execution trace of an agent job

GET /agent/{jobId}/trace

Tag: Agent

The trace is only available for agent runs on spark-2.

Path Parameters

• job_id - Path parameter jobId

Options

• :live_view - when true, the query parameter liveView=true is sent and the response may additionally carry activeBrowserSessions, a list of %{"id" => "...", "liveViewUrl" => "...", "viewport" => %{"width" => 1280, "height" => 720}} entries for the run's live browser sessions.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

Success JSON: %{"success" => true, "id" => "...", "events" => [...], "creditsUsed" => 5}.

Each event has a type field (e.g. "run.started", "tool_call.started", "artifact.updated") plus the base fields schemaVersion, eventId, runId, occurredAt, producerSequence, and agent.

@spec get_agent_trace!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of get_agent_trace. Raises on error.

@spec get_batch_scrape_errors(
  String.t(),
  keyword()
) :: response()

Get the errors of a batch scrape job

GET /batch/scrape/{id}/errors

Tag: Scraping

Path Parameters

• id - Path parameter id

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_batch_scrape_errors!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of get_batch_scrape_errors. Raises on error.

@spec get_batch_scrape_status(
  String.t(),
  keyword()
) :: response()

Get the status of a batch scrape job

GET /batch/scrape/{id}

Tag: Scraping

Path Parameters

• id - Path parameter id

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_batch_scrape_status!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of get_batch_scrape_status. Raises on error.

@spec get_crawl_errors(
  String.t(),
  keyword()
) :: response()

Get the errors of a crawl job

GET /crawl/{id}/errors

Tag: Crawling

Path Parameters

• id - Path parameter id

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_crawl_errors!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of get_crawl_errors. Raises on error.

@spec get_crawl_status(
  String.t(),
  keyword()
) :: response()

Get the status of a crawl job

GET /crawl/{id}

Tag: Crawling

Path Parameters

• id - Path parameter id

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_crawl_status!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of get_crawl_status. Raises on error.

@spec get_credit_usage(keyword()) :: response()

Get remaining credits for the authenticated team

GET /team/credit-usage

Tag: Billing

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_credit_usage!(keyword()) :: Req.Response.t()

Bang variant of get_credit_usage. Raises on error.

@spec get_historical_credit_usage(keyword(), keyword()) :: response()

Get historical credit usage for the authenticated team

GET /team/credit-usage/historical

Tag: Billing

Query Parameters

• by_api_key — query parameter byApiKey

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_historical_credit_usage!(keyword(), keyword()) :: Req.Response.t()

Bang variant of get_historical_credit_usage. Raises on error.

@spec get_monitor(
  String.t(),
  keyword()
) :: response()

Get a monitor by ID.

GET /monitor/{monitorId}

@spec get_monitor!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of get_monitor. Raises on error.

@spec get_monitor_check(String.t(), String.t(), keyword(), keyword()) :: response()

Get a monitor check with paginated page results and inline diffs.

GET /monitor/{monitorId}/checks/{checkId}

@spec get_monitor_check!(String.t(), String.t(), keyword(), keyword()) ::
  Req.Response.t()

Bang variant of get_monitor_check. Raises on error.

@spec get_parse_formats(keyword()) ::
  {:ok, [Firecrawl.ParseFormat.t()]}
  | {:error, Exception.t() | Firecrawl.Error.t()}

List the file formats parse_file/3 accepts

GET /parse/formats

Tag: Parsing

Returns

• {:ok, [%Firecrawl.ParseFormat{}]} on success
• {:error, exception} on HTTP failure or an unexpected response shape

@spec get_parse_formats!(keyword()) :: [Firecrawl.ParseFormat.t()]

Bang variant of get_parse_formats. Raises on error.

@spec get_queue_status(keyword()) :: response()

Metrics about your team's scrape queue

GET /team/queue-status

Tag: Miscellaneous

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_queue_status!(keyword()) :: Req.Response.t()

Bang variant of get_queue_status. Raises on error.

@spec get_scrape_status(
  String.t(),
  keyword()
) :: response()

Get the status of a scrape job

GET /scrape/{jobId}

Tag: Scraping

Path Parameters

• job_id - Path parameter jobId

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_scrape_status!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of get_scrape_status. Raises on error.

@spec get_threat_protection(keyword()) :: response()

Get the team's threat protection policy

GET /team/threat-protection

Tag: Threat Protection

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec get_threat_protection!(keyword()) :: Req.Response.t()

Bang variant of get_threat_protection. Raises on error.

@spec inspect_paper(
  String.t(),
  keyword()
) :: response()

Inspect paper metadata.

GET /search/research/papers/{id}

@spec inspect_paper!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of inspect_paper. Raises on error.

@spec interact_with_scrape_browser_session(String.t(), keyword(), keyword()) ::
  response()

Interact with the browser session associated with a scrape job

POST /scrape/{jobId}/interact

Tag: Scraping

Path Parameters

• job_id - Path parameter jobId

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @interact_with_scrape_browser_session_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec interact_with_scrape_browser_session!(String.t(), keyword(), keyword()) ::
  Req.Response.t()

Bang variant of interact_with_scrape_browser_session. Raises on error.

@spec list_agents(keyword(), keyword()) :: response()

List agent runs

GET /agent

Tag: Agent

Query Parameters

• before — query parameter before

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec list_agents!(keyword(), keyword()) :: Req.Response.t()

Bang variant of list_agents. Raises on error.

@spec list_browser_sessions(keyword(), keyword()) :: response()

List interact sessions

GET /interact

Tag: Interact

Query Parameters

• status — query parameter status

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec list_browser_sessions!(keyword(), keyword()) :: Req.Response.t()

Bang variant of list_browser_sessions. Raises on error.

@spec list_monitor_checks(String.t(), keyword(), keyword()) :: response()

List checks for a monitor.

GET /monitor/{monitorId}/checks

@spec list_monitor_checks!(String.t(), keyword(), keyword()) :: Req.Response.t()

Bang variant of list_monitor_checks. Raises on error.

@spec list_monitors(keyword(), keyword()) :: response()

List monitors for the authenticated team.

GET /monitor

@spec list_monitors!(keyword(), keyword()) :: Req.Response.t()

Bang variant of list_monitors. Raises on error.

@spec map_urls(keyword(), keyword()) :: response()

Map multiple URLs based on options

POST /map

Tag: Mapping

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @map_urls_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec map_urls!(keyword(), keyword()) :: Req.Response.t()

Bang variant of map_urls. Raises on error.

@spec parse_file(keyword(), keyword(), keyword()) :: response()

Upload and parse a file

POST /parse

Sends a multipart/form-data request.

Tag: Scraping

File

Pass file as a keyword list:

• :filename (required) - The filename to send.
• :data (required) - The file contents as a binary.
• :content_type (optional) - The MIME type of the file.

Parameters

Validated by NimbleOptions. Pass options as a keyword list with snake_case keys. These are JSON-encoded and sent as the options multipart field. See @parse_file_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec parse_file!(keyword(), keyword(), keyword()) :: Req.Response.t()

Bang variant of parse_file. Raises on error.

@spec read_paper(String.t(), keyword(), keyword()) :: response()

Read a paper with query-guided passages.

GET /search/research/papers/{id}

@spec read_paper!(String.t(), keyword(), keyword()) :: Req.Response.t()

Bang variant of read_paper. Raises on error.

@spec related_papers(String.t(), keyword(), keyword()) :: response()

Find papers related to a paper.

GET /search/research/papers/{id}/similar

@spec related_papers!(String.t(), keyword(), keyword()) :: Req.Response.t()

Bang variant of related_papers. Raises on error.

@spec run_monitor(
  String.t(),
  keyword()
) :: response()

Trigger a manual monitor check.

POST /monitor/{monitorId}/run

@spec run_monitor!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of run_monitor. Raises on error.

@spec scrape_and_extract_from_url(keyword(), keyword()) :: response()

Scrape a single URL and optionally extract information using an LLM

POST /scrape

Tag: Scraping

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @scrape_and_extract_from_url_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec scrape_and_extract_from_url!(keyword(), keyword()) :: Req.Response.t()

Bang variant of scrape_and_extract_from_url. Raises on error.

@spec scrape_and_extract_from_urls(keyword(), keyword()) :: response()

Scrape multiple URLs and optionally extract information using an LLM

POST /batch/scrape

Tag: Scraping

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @scrape_and_extract_from_urls_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec scrape_and_extract_from_urls!(keyword(), keyword()) :: Req.Response.t()

Bang variant of scrape_and_extract_from_urls. Raises on error.

@spec search_and_scrape(keyword(), keyword()) :: response()

Search and optionally scrape search results

POST /search

Tag: Search

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @search_and_scrape_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec search_and_scrape!(keyword(), keyword()) :: Req.Response.t()

Bang variant of search_and_scrape. Raises on error.

@spec search_github(keyword(), keyword()) :: response()

Search GitHub research content.

GET /search/research/github

@spec search_github!(keyword(), keyword()) :: Req.Response.t()

Bang variant of search_github. Raises on error.

@spec search_papers(keyword(), keyword()) :: response()

Search research papers.

GET /search/research/papers

@spec search_papers!(keyword(), keyword()) :: Req.Response.t()

Bang variant of search_papers. Raises on error.

@spec search_support_docs(keyword(), keyword()) :: response()

Search Firecrawl docs with citations

POST /support/docs-search

Tag: Support

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @search_support_docs_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec search_support_docs!(keyword(), keyword()) :: Req.Response.t()

Bang variant of search_support_docs. Raises on error.

@spec start_agent(keyword(), keyword()) :: response()

Start an agent task for agentic data extraction

POST /agent

Tag: Agent

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @start_agent_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec start_agent!(keyword(), keyword()) :: Req.Response.t()

Bang variant of start_agent. Raises on error.

@spec stop_interactive_scrape_browser_session(
  String.t(),
  keyword()
) :: response()

Stop the interactive browser session associated with a scrape job

DELETE /scrape/{jobId}/interact

Tag: Scraping

Path Parameters

• job_id - Path parameter jobId

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec stop_interactive_scrape_browser_session!(
  String.t(),
  keyword()
) :: Req.Response.t()

Bang variant of stop_interactive_scrape_browser_session. Raises on error.

@spec submit_endpoint_feedback(keyword(), keyword()) :: response()

Submit feedback for a v2 job

POST /feedback

Tag: Feedback

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @submit_endpoint_feedback_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec submit_endpoint_feedback!(keyword(), keyword()) :: Req.Response.t()

Bang variant of submit_endpoint_feedback. Raises on error.

@spec submit_search_feedback(String.t(), keyword(), keyword()) :: response()

Submit feedback for a search job

POST /search/{jobId}/feedback

Tag: Search

Path Parameters

• job_id - Path parameter jobId

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @submit_search_feedback_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec submit_search_feedback!(String.t(), keyword(), keyword()) :: Req.Response.t()

Bang variant of submit_search_feedback. Raises on error.

@spec update_monitor(String.t(), keyword(), keyword()) :: response()

Update a monitor.

PATCH /monitor/{monitorId}

@spec update_monitor!(String.t(), keyword(), keyword()) :: Req.Response.t()

Bang variant of update_monitor. Raises on error.

@spec update_threat_protection(keyword(), keyword()) :: response()

Update the team's threat protection policy

PUT /team/threat-protection

Tag: Threat Protection

Parameters

Validated by NimbleOptions. Pass params as a keyword list with snake_case keys. See @update_threat_protection_schema for the full schema.

Returns

• {:ok, %Req.Response{}} on success
• {:error, exception} on HTTP or validation failure

@spec update_threat_protection!(keyword(), keyword()) :: Req.Response.t()

Bang variant of update_threat_protection. Raises on error.