Firecrawl Search

Usage-based pricing
ae_firecrawl_search

Search web, news, or image sources and return ranked results grouped by source. Provide a non-empty `query`; optionally set `sources` (web, images, or news), `limit` (1–100), time filter `tbs`, `filter`, `location`, `categories` (`github`, `research`, `pdf`, or `developer`), `enterprise`, and `highlights`. Use `includeDomains` to restrict results or `excludeDomains` to exclude hostnames; these fields are mutually exclusive. Search query operators include quoted phrases, `-term`, `site:host`, `inurl:term`, and `intitle:term`. You can provide `scrapeOptions` to extract selected content from returned pages in the same call, with options for formats, parsers, PDF handling, page content selection, screenshots, structured extraction, and related settings. Such fetches ignore `maxAge`; use the dedicated scrape operation when you need a live fetch. Search results normally contain a title, URL, and description, not the full page. Developer-category results are returned in `data.web` with `category: "developer"`; research-category web results are restricted to research-affiliated sites and include snippets. The synchronous response may include `success`, source-grouped `data` (such as `web`, `news`, `images`, or `alexandria`), `id` for optional search feedback, `creditsUsed`, `warning`, `error`, and follow-up/tool metadata such as `nextTool`, `feedbackTool`, `tools`, `agent_hints`, or `conversationId`. `includeDomains` and `excludeDomains` must not both be supplied. This operation does not provide asynchronous job submission or polling.

SearchNewsImage
Usage-based pricing

Pricing

The charge per call is (max(1.2 × actual search and page scraping usage, 0)) AE credits.

If you enable scraping for search results, the metered usage also includes the scraping performed during the call.

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
tbsstringNoTime-based search filter value.—
limitintegerNoNo parameter description.—
querystringYesNo parameter description.—
filterstringNoAdditional filter for search results.—
sourcesarrayNoSearch sources to query, such as web, images, or news.—
sources[].typeenum (web | images | news)YesNo parameter description.—
locationstringNoLocation settings used to localize search results.—
categoriesarrayNoNo parameter description.—
enterprisearrayNoNo parameter description.—
highlightsbooleanNoNo parameter description.—
scrapeOptionsobjectNoOptions for scraping content from returned search-result pages.—
scrapeOptions.proxyenum (basic | stealth | enhanced | auto)NoNo parameter description.—
scrapeOptions.maxAgenumberNoMaximum acceptable age of a cached result.—
scrapeOptions.mobilebooleanNoUse a mobile browser viewport when scraping pages.—
scrapeOptions.formatsarrayNoOutput formats to generate when scraping search-result pages.—
scrapeOptions.parsersarrayNoParsers to apply when processing scraped page content.—
scrapeOptions.profileobjectNoBrowser profile settings used while scraping pages.—
scrapeOptions.profile.namestringYesNo parameter description.—
scrapeOptions.profile.saveChangesbooleanNoSave changes made during the browser session to the profile.—
scrapeOptions.waitFornumberNoTime to wait for page content to load before scraping.—
scrapeOptions.locationobjectNoLocation settings used when scraping pages.—
scrapeOptions.location.countrystringNoNo parameter description.—
scrapeOptions.location.languagesarrayNoPreferred languages for localized page retrieval.—
scrapeOptions.lockdownbooleanNoNo parameter description.—
scrapeOptions.redactPIIbooleanNoRedact personally identifiable information from scraped content.—
scrapeOptions.pdfOptionsobjectNoOptions for processing PDF content.—
scrapeOptions.pdfOptions.maxPagesintegerNoMaximum number of PDF pages to process.—
scrapeOptions.excludeTagsarrayNoExclude content within these HTML tags.—
scrapeOptions.includeTagsarrayNoInclude only content within these HTML tags.—
scrapeOptions.jsonOptionsobjectNoOptions for extracting structured JSON from scraped pages.—
scrapeOptions.jsonOptions.promptstringNoInstructions for extracting structured data from scraped page content.—
scrapeOptions.jsonOptions.schemaobjectNoJSON schema that defines the structured data to extract from scraped pages.—
scrapeOptions.queryOptionsobjectNoOptions for querying scraped page content.—
scrapeOptions.queryOptions.modeenum (directQuote | freeform)YesNo parameter description.freeform
scrapeOptions.queryOptions.promptstringYesPrompt used to query or extract information from scraped page content.—
scrapeOptions.storeInCachebooleanNoStore scraped results in the cache for later reuse.—
scrapeOptions.onlyMainContentbooleanNoExtract only the main page content and exclude navigation, headers, footers, and other boilerplate where possible.—
scrapeOptions.screenshotOptionsobjectNoOptions for screenshots captured while scraping pages.—
scrapeOptions.screenshotOptions.qualitynumberNoScreenshot image quality setting.—
scrapeOptions.screenshotOptions.fullPagebooleanNoCapture the full page instead of only the visible viewport.—
scrapeOptions.screenshotOptions.viewportobjectNoViewport dimensions used when capturing screenshots.—
scrapeOptions.screenshotOptions.viewport.widthnumberYesNo parameter description.—
scrapeOptions.screenshotOptions.viewport.heightnumberYesNo parameter description.—
scrapeOptions.zeroDataRetentionbooleanNoDo not retain scraped data after processing.—
scrapeOptions.removeBase64ImagesbooleanNoRemove Base64-encoded images from scraped content.—
scrapeOptions.skipTlsVerificationbooleanNoSkip TLS certificate verification when loading pages.—
excludeDomainsarrayNoExclude results from these domain hostnames. Do not include protocols or paths. Do not use with `includeDomains`.—
includeDomainsarrayNoRestrict results to these domain hostnames. Do not include protocols or paths. Do not use with `excludeDomains`.—

Invocation example

Copy the request and explore its response example.

POST/agent-api/v1/tool/executeX-Api-Key
Request coderequest.sh
curl --request POST \
  --url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_firecrawl_search' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "limit": 10,
    "query": "\"1097325847299\"",
    "sources": [
      {
        "type": "web"
      }
    ]
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "agent_hints": [
    "No web results were returned. If the task is still unresolved, use firecrawl_search again with {\"query\":\"<broader or alternative query>\",\"sources\":[\"web\"]}."
  ],
  "conversationId": "184ee620-62bc-449f-b862-203a12f62b47",
  "data": {
    "tools": [
      {
        "capability": "audio-recordings/get_cylinder",
        "description": "MP3 links, licence and credit for one cylinder, e.g. https://cylinders.library.ucsb.edu/detail.php?query_type=mms_id&query=9948000799203776, cylinder 17334, or http://www.library.ucsb.edu/OBJID/Cylinder17334.",
        "provider": "cylinders-library-ucsb-edu"
      }
    ],
    "web": []
  },
  "id": "01a1caa0-2d03-7359-aaab-fe52373417d5",
  "success": true
}

This example shows part of the response. Copied content is valid JSON.

Guides using this tool

See how this tool fits into real workflows