Extract structured data from pages using LLMs
curl --request POST \
--url https://api.firecrawl.dev/v1/extract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"urls": [
"<string>"
],
"prompt": "<string>",
"schema": {},
"enableWebSearch": false,
"ignoreSitemap": false,
"includeSubdomains": true,
"showSources": false,
"scrapeOptions": {
"onlyMainContent": true,
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"maxAge": 0,
"headers": {},
"waitFor": 0,
"mobile": false,
"skipTlsVerification": false,
"timeout": 30000,
"parsePDF": true,
"jsonOptions": {
"schema": {},
"systemPrompt": "<string>",
"prompt": "<string>",
"checkPromptInjection": false
},
"actions": [
{
"type": "wait",
"milliseconds": 2,
"selector": "#my-element"
}
],
"location": {
"country": "US",
"languages": [
"en-US"
]
},
"removeBase64Images": true,
"blockAds": true,
"storeInCache": true,
"threatProtection": {
"riskScoreThreshold": 75,
"blacklist": [
"<string>"
],
"whitelist": [
"<string>"
],
"blockedTlds": [
"<string>"
]
},
"formats": [
"markdown"
],
"changeTrackingOptions": {
"modes": [],
"schema": {},
"prompt": "<string>",
"tag": null
}
},
"ignoreInvalidURLs": false,
"threatProtection": {
"riskScoreThreshold": 75,
"blacklist": [
"<string>"
],
"whitelist": [
"<string>"
],
"blockedTlds": [
"<string>"
]
}
}
'import requests
url = "https://api.firecrawl.dev/v1/extract"
payload = {
"urls": ["<string>"],
"prompt": "<string>",
"schema": {},
"enableWebSearch": False,
"ignoreSitemap": False,
"includeSubdomains": True,
"showSources": False,
"scrapeOptions": {
"onlyMainContent": True,
"includeTags": ["<string>"],
"excludeTags": ["<string>"],
"maxAge": 0,
"headers": {},
"waitFor": 0,
"mobile": False,
"skipTlsVerification": False,
"timeout": 30000,
"parsePDF": True,
"jsonOptions": {
"schema": {},
"systemPrompt": "<string>",
"prompt": "<string>",
"checkPromptInjection": False
},
"actions": [
{
"type": "wait",
"milliseconds": 2,
"selector": "#my-element"
}
],
"location": {
"country": "US",
"languages": ["en-US"]
},
"removeBase64Images": True,
"blockAds": True,
"storeInCache": True,
"threatProtection": {
"riskScoreThreshold": 75,
"blacklist": ["<string>"],
"whitelist": ["<string>"],
"blockedTlds": ["<string>"]
},
"formats": ["markdown"],
"changeTrackingOptions": {
"modes": [],
"schema": {},
"prompt": "<string>",
"tag": None
}
},
"ignoreInvalidURLs": False,
"threatProtection": {
"riskScoreThreshold": 75,
"blacklist": ["<string>"],
"whitelist": ["<string>"],
"blockedTlds": ["<string>"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
urls: ['<string>'],
prompt: '<string>',
schema: {},
enableWebSearch: false,
ignoreSitemap: false,
includeSubdomains: true,
showSources: false,
scrapeOptions: {
onlyMainContent: true,
includeTags: ['<string>'],
excludeTags: ['<string>'],
maxAge: 0,
headers: {},
waitFor: 0,
mobile: false,
skipTlsVerification: false,
timeout: 30000,
parsePDF: true,
jsonOptions: {
schema: {},
systemPrompt: '<string>',
prompt: '<string>',
checkPromptInjection: false
},
actions: [{type: 'wait', milliseconds: 2, selector: '#my-element'}],
location: {country: 'US', languages: ['en-US']},
removeBase64Images: true,
blockAds: true,
storeInCache: true,
threatProtection: {
riskScoreThreshold: 75,
blacklist: ['<string>'],
whitelist: ['<string>'],
blockedTlds: ['<string>']
},
formats: ['markdown'],
changeTrackingOptions: {modes: [], schema: {}, prompt: '<string>', tag: null}
},
ignoreInvalidURLs: false,
threatProtection: {
riskScoreThreshold: 75,
blacklist: ['<string>'],
whitelist: ['<string>'],
blockedTlds: ['<string>']
}
})
};
fetch('https://api.firecrawl.dev/v1/extract', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firecrawl.dev/v1/extract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'urls' => [
'<string>'
],
'prompt' => '<string>',
'schema' => [
],
'enableWebSearch' => false,
'ignoreSitemap' => false,
'includeSubdomains' => true,
'showSources' => false,
'scrapeOptions' => [
'onlyMainContent' => true,
'includeTags' => [
'<string>'
],
'excludeTags' => [
'<string>'
],
'maxAge' => 0,
'headers' => [
],
'waitFor' => 0,
'mobile' => false,
'skipTlsVerification' => false,
'timeout' => 30000,
'parsePDF' => true,
'jsonOptions' => [
'schema' => [
],
'systemPrompt' => '<string>',
'prompt' => '<string>',
'checkPromptInjection' => false
],
'actions' => [
[
'type' => 'wait',
'milliseconds' => 2,
'selector' => '#my-element'
]
],
'location' => [
'country' => 'US',
'languages' => [
'en-US'
]
],
'removeBase64Images' => true,
'blockAds' => true,
'storeInCache' => true,
'threatProtection' => [
'riskScoreThreshold' => 75,
'blacklist' => [
'<string>'
],
'whitelist' => [
'<string>'
],
'blockedTlds' => [
'<string>'
]
],
'formats' => [
'markdown'
],
'changeTrackingOptions' => [
'modes' => [
],
'schema' => [
],
'prompt' => '<string>',
'tag' => null
]
],
'ignoreInvalidURLs' => false,
'threatProtection' => [
'riskScoreThreshold' => 75,
'blacklist' => [
'<string>'
],
'whitelist' => [
'<string>'
],
'blockedTlds' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firecrawl.dev/v1/extract"
payload := strings.NewReader("{\n \"urls\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\",\n \"schema\": {},\n \"enableWebSearch\": false,\n \"ignoreSitemap\": false,\n \"includeSubdomains\": true,\n \"showSources\": false,\n \"scrapeOptions\": {\n \"onlyMainContent\": true,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"maxAge\": 0,\n \"headers\": {},\n \"waitFor\": 0,\n \"mobile\": false,\n \"skipTlsVerification\": false,\n \"timeout\": 30000,\n \"parsePDF\": true,\n \"jsonOptions\": {\n \"schema\": {},\n \"systemPrompt\": \"<string>\",\n \"prompt\": \"<string>\",\n \"checkPromptInjection\": false\n },\n \"actions\": [\n {\n \"type\": \"wait\",\n \"milliseconds\": 2,\n \"selector\": \"#my-element\"\n }\n ],\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n },\n \"removeBase64Images\": true,\n \"blockAds\": true,\n \"storeInCache\": true,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n },\n \"formats\": [\n \"markdown\"\n ],\n \"changeTrackingOptions\": {\n \"modes\": [],\n \"schema\": {},\n \"prompt\": \"<string>\",\n \"tag\": null\n }\n },\n \"ignoreInvalidURLs\": false,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v1/extract")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"urls\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\",\n \"schema\": {},\n \"enableWebSearch\": false,\n \"ignoreSitemap\": false,\n \"includeSubdomains\": true,\n \"showSources\": false,\n \"scrapeOptions\": {\n \"onlyMainContent\": true,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"maxAge\": 0,\n \"headers\": {},\n \"waitFor\": 0,\n \"mobile\": false,\n \"skipTlsVerification\": false,\n \"timeout\": 30000,\n \"parsePDF\": true,\n \"jsonOptions\": {\n \"schema\": {},\n \"systemPrompt\": \"<string>\",\n \"prompt\": \"<string>\",\n \"checkPromptInjection\": false\n },\n \"actions\": [\n {\n \"type\": \"wait\",\n \"milliseconds\": 2,\n \"selector\": \"#my-element\"\n }\n ],\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n },\n \"removeBase64Images\": true,\n \"blockAds\": true,\n \"storeInCache\": true,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n },\n \"formats\": [\n \"markdown\"\n ],\n \"changeTrackingOptions\": {\n \"modes\": [],\n \"schema\": {},\n \"prompt\": \"<string>\",\n \"tag\": null\n }\n },\n \"ignoreInvalidURLs\": false,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firecrawl.dev/v1/extract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"urls\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\",\n \"schema\": {},\n \"enableWebSearch\": false,\n \"ignoreSitemap\": false,\n \"includeSubdomains\": true,\n \"showSources\": false,\n \"scrapeOptions\": {\n \"onlyMainContent\": true,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"maxAge\": 0,\n \"headers\": {},\n \"waitFor\": 0,\n \"mobile\": false,\n \"skipTlsVerification\": false,\n \"timeout\": 30000,\n \"parsePDF\": true,\n \"jsonOptions\": {\n \"schema\": {},\n \"systemPrompt\": \"<string>\",\n \"prompt\": \"<string>\",\n \"checkPromptInjection\": false\n },\n \"actions\": [\n {\n \"type\": \"wait\",\n \"milliseconds\": 2,\n \"selector\": \"#my-element\"\n }\n ],\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n },\n \"removeBase64Images\": true,\n \"blockAds\": true,\n \"storeInCache\": true,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n },\n \"formats\": [\n \"markdown\"\n ],\n \"changeTrackingOptions\": {\n \"modes\": [],\n \"schema\": {},\n \"prompt\": \"<string>\",\n \"tag\": null\n }\n },\n \"ignoreInvalidURLs\": false,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"id": "<string>",
"invalidURLs": [
"<string>"
]
}{
"error": "Invalid input data."
}{
"error": "An unexpected error occurred on the server."
}Extract Endpoints
Extract
POST
/
extract
Extract structured data from pages using LLMs
curl --request POST \
--url https://api.firecrawl.dev/v1/extract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"urls": [
"<string>"
],
"prompt": "<string>",
"schema": {},
"enableWebSearch": false,
"ignoreSitemap": false,
"includeSubdomains": true,
"showSources": false,
"scrapeOptions": {
"onlyMainContent": true,
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"maxAge": 0,
"headers": {},
"waitFor": 0,
"mobile": false,
"skipTlsVerification": false,
"timeout": 30000,
"parsePDF": true,
"jsonOptions": {
"schema": {},
"systemPrompt": "<string>",
"prompt": "<string>",
"checkPromptInjection": false
},
"actions": [
{
"type": "wait",
"milliseconds": 2,
"selector": "#my-element"
}
],
"location": {
"country": "US",
"languages": [
"en-US"
]
},
"removeBase64Images": true,
"blockAds": true,
"storeInCache": true,
"threatProtection": {
"riskScoreThreshold": 75,
"blacklist": [
"<string>"
],
"whitelist": [
"<string>"
],
"blockedTlds": [
"<string>"
]
},
"formats": [
"markdown"
],
"changeTrackingOptions": {
"modes": [],
"schema": {},
"prompt": "<string>",
"tag": null
}
},
"ignoreInvalidURLs": false,
"threatProtection": {
"riskScoreThreshold": 75,
"blacklist": [
"<string>"
],
"whitelist": [
"<string>"
],
"blockedTlds": [
"<string>"
]
}
}
'import requests
url = "https://api.firecrawl.dev/v1/extract"
payload = {
"urls": ["<string>"],
"prompt": "<string>",
"schema": {},
"enableWebSearch": False,
"ignoreSitemap": False,
"includeSubdomains": True,
"showSources": False,
"scrapeOptions": {
"onlyMainContent": True,
"includeTags": ["<string>"],
"excludeTags": ["<string>"],
"maxAge": 0,
"headers": {},
"waitFor": 0,
"mobile": False,
"skipTlsVerification": False,
"timeout": 30000,
"parsePDF": True,
"jsonOptions": {
"schema": {},
"systemPrompt": "<string>",
"prompt": "<string>",
"checkPromptInjection": False
},
"actions": [
{
"type": "wait",
"milliseconds": 2,
"selector": "#my-element"
}
],
"location": {
"country": "US",
"languages": ["en-US"]
},
"removeBase64Images": True,
"blockAds": True,
"storeInCache": True,
"threatProtection": {
"riskScoreThreshold": 75,
"blacklist": ["<string>"],
"whitelist": ["<string>"],
"blockedTlds": ["<string>"]
},
"formats": ["markdown"],
"changeTrackingOptions": {
"modes": [],
"schema": {},
"prompt": "<string>",
"tag": None
}
},
"ignoreInvalidURLs": False,
"threatProtection": {
"riskScoreThreshold": 75,
"blacklist": ["<string>"],
"whitelist": ["<string>"],
"blockedTlds": ["<string>"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
urls: ['<string>'],
prompt: '<string>',
schema: {},
enableWebSearch: false,
ignoreSitemap: false,
includeSubdomains: true,
showSources: false,
scrapeOptions: {
onlyMainContent: true,
includeTags: ['<string>'],
excludeTags: ['<string>'],
maxAge: 0,
headers: {},
waitFor: 0,
mobile: false,
skipTlsVerification: false,
timeout: 30000,
parsePDF: true,
jsonOptions: {
schema: {},
systemPrompt: '<string>',
prompt: '<string>',
checkPromptInjection: false
},
actions: [{type: 'wait', milliseconds: 2, selector: '#my-element'}],
location: {country: 'US', languages: ['en-US']},
removeBase64Images: true,
blockAds: true,
storeInCache: true,
threatProtection: {
riskScoreThreshold: 75,
blacklist: ['<string>'],
whitelist: ['<string>'],
blockedTlds: ['<string>']
},
formats: ['markdown'],
changeTrackingOptions: {modes: [], schema: {}, prompt: '<string>', tag: null}
},
ignoreInvalidURLs: false,
threatProtection: {
riskScoreThreshold: 75,
blacklist: ['<string>'],
whitelist: ['<string>'],
blockedTlds: ['<string>']
}
})
};
fetch('https://api.firecrawl.dev/v1/extract', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firecrawl.dev/v1/extract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'urls' => [
'<string>'
],
'prompt' => '<string>',
'schema' => [
],
'enableWebSearch' => false,
'ignoreSitemap' => false,
'includeSubdomains' => true,
'showSources' => false,
'scrapeOptions' => [
'onlyMainContent' => true,
'includeTags' => [
'<string>'
],
'excludeTags' => [
'<string>'
],
'maxAge' => 0,
'headers' => [
],
'waitFor' => 0,
'mobile' => false,
'skipTlsVerification' => false,
'timeout' => 30000,
'parsePDF' => true,
'jsonOptions' => [
'schema' => [
],
'systemPrompt' => '<string>',
'prompt' => '<string>',
'checkPromptInjection' => false
],
'actions' => [
[
'type' => 'wait',
'milliseconds' => 2,
'selector' => '#my-element'
]
],
'location' => [
'country' => 'US',
'languages' => [
'en-US'
]
],
'removeBase64Images' => true,
'blockAds' => true,
'storeInCache' => true,
'threatProtection' => [
'riskScoreThreshold' => 75,
'blacklist' => [
'<string>'
],
'whitelist' => [
'<string>'
],
'blockedTlds' => [
'<string>'
]
],
'formats' => [
'markdown'
],
'changeTrackingOptions' => [
'modes' => [
],
'schema' => [
],
'prompt' => '<string>',
'tag' => null
]
],
'ignoreInvalidURLs' => false,
'threatProtection' => [
'riskScoreThreshold' => 75,
'blacklist' => [
'<string>'
],
'whitelist' => [
'<string>'
],
'blockedTlds' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firecrawl.dev/v1/extract"
payload := strings.NewReader("{\n \"urls\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\",\n \"schema\": {},\n \"enableWebSearch\": false,\n \"ignoreSitemap\": false,\n \"includeSubdomains\": true,\n \"showSources\": false,\n \"scrapeOptions\": {\n \"onlyMainContent\": true,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"maxAge\": 0,\n \"headers\": {},\n \"waitFor\": 0,\n \"mobile\": false,\n \"skipTlsVerification\": false,\n \"timeout\": 30000,\n \"parsePDF\": true,\n \"jsonOptions\": {\n \"schema\": {},\n \"systemPrompt\": \"<string>\",\n \"prompt\": \"<string>\",\n \"checkPromptInjection\": false\n },\n \"actions\": [\n {\n \"type\": \"wait\",\n \"milliseconds\": 2,\n \"selector\": \"#my-element\"\n }\n ],\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n },\n \"removeBase64Images\": true,\n \"blockAds\": true,\n \"storeInCache\": true,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n },\n \"formats\": [\n \"markdown\"\n ],\n \"changeTrackingOptions\": {\n \"modes\": [],\n \"schema\": {},\n \"prompt\": \"<string>\",\n \"tag\": null\n }\n },\n \"ignoreInvalidURLs\": false,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v1/extract")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"urls\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\",\n \"schema\": {},\n \"enableWebSearch\": false,\n \"ignoreSitemap\": false,\n \"includeSubdomains\": true,\n \"showSources\": false,\n \"scrapeOptions\": {\n \"onlyMainContent\": true,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"maxAge\": 0,\n \"headers\": {},\n \"waitFor\": 0,\n \"mobile\": false,\n \"skipTlsVerification\": false,\n \"timeout\": 30000,\n \"parsePDF\": true,\n \"jsonOptions\": {\n \"schema\": {},\n \"systemPrompt\": \"<string>\",\n \"prompt\": \"<string>\",\n \"checkPromptInjection\": false\n },\n \"actions\": [\n {\n \"type\": \"wait\",\n \"milliseconds\": 2,\n \"selector\": \"#my-element\"\n }\n ],\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n },\n \"removeBase64Images\": true,\n \"blockAds\": true,\n \"storeInCache\": true,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n },\n \"formats\": [\n \"markdown\"\n ],\n \"changeTrackingOptions\": {\n \"modes\": [],\n \"schema\": {},\n \"prompt\": \"<string>\",\n \"tag\": null\n }\n },\n \"ignoreInvalidURLs\": false,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firecrawl.dev/v1/extract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"urls\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\",\n \"schema\": {},\n \"enableWebSearch\": false,\n \"ignoreSitemap\": false,\n \"includeSubdomains\": true,\n \"showSources\": false,\n \"scrapeOptions\": {\n \"onlyMainContent\": true,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"maxAge\": 0,\n \"headers\": {},\n \"waitFor\": 0,\n \"mobile\": false,\n \"skipTlsVerification\": false,\n \"timeout\": 30000,\n \"parsePDF\": true,\n \"jsonOptions\": {\n \"schema\": {},\n \"systemPrompt\": \"<string>\",\n \"prompt\": \"<string>\",\n \"checkPromptInjection\": false\n },\n \"actions\": [\n {\n \"type\": \"wait\",\n \"milliseconds\": 2,\n \"selector\": \"#my-element\"\n }\n ],\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n },\n \"removeBase64Images\": true,\n \"blockAds\": true,\n \"storeInCache\": true,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n },\n \"formats\": [\n \"markdown\"\n ],\n \"changeTrackingOptions\": {\n \"modes\": [],\n \"schema\": {},\n \"prompt\": \"<string>\",\n \"tag\": null\n }\n },\n \"ignoreInvalidURLs\": false,\n \"threatProtection\": {\n \"riskScoreThreshold\": 75,\n \"blacklist\": [\n \"<string>\"\n ],\n \"whitelist\": [\n \"<string>\"\n ],\n \"blockedTlds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"id": "<string>",
"invalidURLs": [
"<string>"
]
}{
"error": "Invalid input data."
}{
"error": "An unexpected error occurred on the server."
}Note: A new v2 version of this API is now available with improved features and performance.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The URLs to extract data from. URLs should be in glob format.
Prompt to guide the extraction process
Schema to define the structure of the extracted data. Must conform to JSON Schema.
When true, the extraction will use web search to find additional data
When true, sitemap.xml files will be ignored during website scanning
When true, subdomains of the provided URLs will also be scanned
When true, the sources used to extract the data will be included in the response as sources key
Show child attributes
Show child attributes
If invalid URLs are specified in the urls array, they will be ignored. Instead of them failing the entire request, an extract using the remaining valid URLs will be performed, and the invalid URLs will be returned in the invalidURLs field of the response.
Per-request Threat Protection override. Fields you provide replace the corresponding fields of your organization's policy for this request only; omitted fields keep their organization-level values. Requires Threat Protection to be enabled for your team (enterprise feature) — otherwise the request is rejected with a 403. If your organization has disabled request overrides, any request that includes this object is rejected with a 403. If Threat Protection is enforced for your team, mode may not be set to off.
Show child attributes
Show child attributes
Response
Successful extraction