From b244afbc82dfc1b73d56b09279f5ed16c6cb4902 Mon Sep 17 00:00:00 2001 From: Nicolas Date: Thu, 2 Jan 2025 20:26:51 -0300 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d44bde8c..658fb8be 100644 --- a/README.md +++ b/README.md @@ -365,19 +365,18 @@ curl -X POST https://api.firecrawl.dev/v1/batch/scrape \ }' ``` -### Search (v0) (Beta) +### Search -Used to search the web, get the most relevant results, scrape each page and return the markdown. +The search endpoint combines web search with Firecrawl’s scraping capabilities to return full page content for any query. + +Include `scrapeOptions` with `formats: ["markdown"]` to get complete markdown content for each search result otherwise it defaults to getting SERP results (url, title, description). ```bash -curl -X POST https://api.firecrawl.dev/v0/search \ +curl -X POST https://api.firecrawl.dev/v1/search \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -d '{ - "query": "firecrawl", - "pageOptions": { - "fetchPageContent": true // false for a fast serp api - } + "query": "What is Mendable?" }' ``` @@ -387,14 +386,8 @@ curl -X POST https://api.firecrawl.dev/v0/search \ "data": [ { "url": "https://mendable.ai", - "markdown": "# Markdown Content", - "provider": "web-scraper", - "metadata": { - "title": "Mendable | AI for CX and Sales", - "description": "AI for CX and Sales", - "language": null, - "sourceURL": "https://www.mendable.ai/" - } + "title": "Mendable | AI for CX and Sales", + "description": "AI for CX and Sales" } ] }