Class: Firecrawl::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/firecrawl/request.rb

Overview

The Request class encapsulates a request to the Firecrawl API. After creating a new Request instance you can make the actual request by calling the scrape, begin_crawl crawl, end_crawl or map methods.

example

require ‘firecrawl’

request = Firecrawl::Request.new( api_key: ENV[ ‘FIRECRAWL_API_KEY’ )

options = Firecrawl::ScrapeOptions.build do

format                [ :markdown, :screenshot ]
only_main_content     true

end

response = request.scrape( ‘cnn.com’, criteria ) if response.success?

result = response.result 
puts response.metadata[ :title ] 
puts '---'
puts response.markdown

else

puts response.result.error_description

end

Constant Summary collapse

BASE_URI = 
'https://api.firecrawl.dev/v2'

Instance Method Summary collapse

Constructor Details

#initialize(connection: nil, api_key: nil) ⇒ Request

The initialize method initializes the Request instance. You MUST pass an api_key and and optionally a (Faraday) connection.

Raises:

  • (ArgumentError) 


37
38
39
40
41
42
 
# File 'lib/firecrawl/request.rb', line 37

def initialize( connection: nil, api_key: nil )
  @connection = connection || Firecrawl.connection
  @api_key = api_key || Firecrawl.api_key
  raise ArgumentError, "An 'api_key' is required unless configured using 'Firecrawl.api_key'." \
    unless @api_key
end