firecrawl-sdk 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a3360b0facad41a4d3c0a1a94e520f675ce5b6f72487665ead37f1b988de50
-  data.tar.gz: 51ced5462346c81d02327786e5022cd5789fed14940346e231c8619eb5b686b6
+  metadata.gz: 364810a7f7627c43f70a5d9f008f3a3fc0bcfb2f655a780190d93f8b577de1bf
+  data.tar.gz: 8191bc44441edd5d9abe7671cfc9851388058be954684cc92ddf0e37cf7e3669
 SHA512:
-  metadata.gz: 2e7a56e1fc2bd3b56b88337047f7c655c7ac78e6d43de94f4ee89c9b67701be95b45232d17ce6383023bd3d59199388012257c32d36c10c61823b02f5574f931
-  data.tar.gz: f2be762f47550bfa3bda7e7d8e7833b404b30d5447558893bc36ffe5de13953cc02bc00efe09d51f91eec9c1715701275e50336d154d2c47f4d5121a424aeb87
+  metadata.gz: 83d1e41c97ec1abb35b8d14cb0d7003b1a8a3aadbd99ff0526c088e52b75405a80b7dda5b6cb8e6e7ea9edcaa1e519d13e8b5884dcd04880cdb24b4f7a7346d6
+  data.tar.gz: 057e47a4e06af5dc218413fd574aa7b6f22a09e3ec3878efe2d3cc4d6ef0dbdbd6b2db28ab11b48fbb7385d7b6b76d58f452b04c0698468e3597c5e08af50c58

data/README.md

@@ -11,7 +11,7 @@ Ruby SDK for the [Firecrawl](https://firecrawl.dev) v2 web scraping API.
 Add to your `Gemfile`:
 
 ```ruby
-gem "firecrawl-sdk", "~> 1.0"
+gem "firecrawl-sdk", "~> 1.5"
 ```
 
 Or install directly:
@@ -63,12 +63,23 @@ doc = client.scrape("https://example.com",
 puts doc.html
 ```
 
+### Video Extraction
+
+Use the `video` format on supported video URLs, including YouTube and TikTok. The returned `video` field is a signed URL to the extracted video file.
+
+```ruby
+doc = client.scrape("https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+  Firecrawl::Models::ScrapeOptions.new(formats: ["video"]))
+
+puts doc.video
+```
+
 ### Parse
 
 Upload a local file (`html`, `pdf`, `docx`, etc.) via multipart form data and
 parse it synchronously. Parse options intentionally exclude browser-only
-features such as change tracking, screenshot, branding, actions, wait_for,
-location, and mobile. The `proxy` option only accepts `"auto"` or `"basic"`.
+features such as change tracking, screenshot, branding, audio, video, actions,
+wait_for, location, and mobile. The `proxy` option only accepts `"auto"` or `"basic"`.
 
 ```ruby
 # From disk

data/lib/firecrawl/models/document.rb

@@ -6,7 +6,8 @@ module Firecrawl
     class Document
       attr_reader :markdown, :html, :raw_html, :json, :summary,
                   :metadata, :links, :images, :screenshot, :audio,
-                  :attributes, :actions, :warning, :change_tracking, :branding
+                  :video, :attributes, :actions, :answer, :highlights,
+                  :warning, :change_tracking, :branding
 
       def initialize(data)
         @markdown = data["markdown"]
@@ -19,8 +20,11 @@ module Firecrawl
         @images = data["images"]
         @screenshot = data["screenshot"]
         @audio = data["audio"]
+        @video = data["video"]
         @attributes = data["attributes"]
         @actions = data["actions"]
+        @answer = data["answer"]
+        @highlights = data["highlights"]
         @warning = data["warning"]
         @change_tracking = data["changeTracking"]
         @branding = data["branding"]

data/lib/firecrawl/models/parse_options.rb

@@ -5,10 +5,10 @@ module Firecrawl
     # Options for parsing uploaded files via `/v2/parse`.
     #
     # Parse does not support browser-rendering features (actions, waitFor,
-    # location, mobile) nor screenshot/branding/changeTracking formats. The
+    # location, mobile) nor screenshot/branding/audio/video/changeTracking formats. The
     # proxy field only accepts "auto" or "basic".
     class ParseOptions
-      UNSUPPORTED_FORMATS = %w[changeTracking screenshot screenshot@fullPage branding].freeze
+      UNSUPPORTED_FORMATS = %w[changeTracking screenshot screenshot@fullPage branding audio video].freeze
 
       FIELDS = %i[
         formats headers include_tags exclude_tags only_main_content

data/lib/firecrawl/models/query_format.rb

@@ -2,7 +2,47 @@
 
 module Firecrawl
   module Models
-    # Query format for asking a question about page content.
+    # Question format for asking a question about page content.
+    class QuestionFormat
+      attr_reader :question
+
+      def initialize(question:)
+        @question = question
+      end
+
+      def to_h
+        {
+          "type" => "question",
+          "question" => question,
+        }
+      end
+
+      def type
+        "question"
+      end
+    end
+
+    # Highlights format for extracting direct highlights from page content.
+    class HighlightsFormat
+      attr_reader :query
+
+      def initialize(query:)
+        @query = query
+      end
+
+      def to_h
+        {
+          "type" => "highlights",
+          "query" => query,
+        }
+      end
+
+      def type
+        "highlights"
+      end
+    end
+
+    # Deprecated query format for asking a question about page content.
     class QueryFormat
       MODE_FREEFORM = "freeform"
       MODE_DIRECT_QUOTE = "directQuote"

data/lib/firecrawl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Firecrawl
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firecrawl-sdk
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Firecrawl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-06 00:00:00.000000000 Z
+date: 2026-05-12 00:00:00.000000000 Z
 dependencies: []
 description: A type-safe Ruby client for the Firecrawl v2 API. Supports scraping,
   crawling, batch scraping, URL mapping, web search, and AI agent operations.