Skip to content

Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥

fix(js-sdk): accept string API key in constructor

Himadri M60c251f86ce6
diff --git a/apps/js-sdk/firecrawl/src/index.ts b/apps/js-sdk/firecrawl/src/index.ts
index 3e66d6746..12f9b5a16 100644
--- a/apps/js-sdk/firecrawl/src/index.ts
+++ b/apps/js-sdk/firecrawl/src/index.ts
@@ -15,11 +15,11 @@ export { Watcher, type WatcherOptions } from "./v2/watcher";
export { default as FirecrawlAppV1 } from "./v1";
import V1 from "./v1";
-import { FirecrawlClient as V2, type FirecrawlClientOptions } from "./v2/client";
+import { FirecrawlClient as V2, type FirecrawlClientOptions, type FirecrawlClientInput } from "./v2/client";
import type { FirecrawlAppConfig } from "./v1";
// Re-export v2 client options for convenience
-export type { FirecrawlClientOptions } from "./v2/client";
+export type { FirecrawlClientOptions, FirecrawlClientInput } from "./v2/client";
/** Unified client: extends v2 and adds `.v1` for backward compatibility. */
export class Firecrawl extends V2 {
@@ -27,12 +27,14 @@ export class Firecrawl extends V2 {
private _v1?: V1;
private _v1Opts: FirecrawlAppConfig;
- /** @param opts API credentials and base URL. */
- constructor(opts: FirecrawlClientOptions = {}) {
- super(opts);
+ /** @param opts API key string or credentials object. */
+ constructor(opts: FirecrawlClientInput = {}) {
+ const resolved: FirecrawlClientOptions =
+ typeof opts === "string" ? { apiKey: opts } : opts;
+ super(resolved);
this._v1Opts = {
- apiKey: opts.apiKey,
- apiUrl: opts.apiUrl,
+ apiKey: resolved.apiKey,
+ apiUrl: resolved.apiUrl,
};
}
diff --git a/apps/js-sdk/firecrawl/src/v2/client.ts b/apps/js-sdk/firecrawl/src/v2/client.ts
index ccd93d8a1..96b8db9cf 100644
--- a/apps/js-sdk/firecrawl/src/v2/client.ts
+++ b/apps/js-sdk/firecrawl/src/v2/client.ts
@@ -110,6 +110,9 @@ export interface FirecrawlClientOptions {
backoffFactor?: number;
}
+/** Accepts a plain API key string or a full options object. */
+export type FirecrawlClientInput = FirecrawlClientOptions | string;
+
/**
* Firecrawl v2 client. Provides typed access to all v2 endpoints and utilities.
*/
@@ -123,11 +126,14 @@ export class FirecrawlClient {
/**
* Create a v2 client.
- * @param options Transport configuration (API key, base URL, timeouts, retries).
+ * @param options API key string or transport configuration object.
*/
- constructor(options: FirecrawlClientOptions = {}) {
- const apiKey = options.apiKey ?? process.env.FIRECRAWL_API_KEY ?? "";
- const apiUrl = (options.apiUrl ?? process.env.FIRECRAWL_API_URL ?? "https://api.firecrawl.dev").replace(/\/$/, "");
+ constructor(options: FirecrawlClientInput = {}) {
+ const opts: FirecrawlClientOptions =
+ typeof options === "string" ? { apiKey: options } : options;
+
+ const apiKey = opts.apiKey ?? process.env.FIRECRAWL_API_KEY ?? "";
+ const apiUrl = (opts.apiUrl ?? process.env.FIRECRAWL_API_URL ?? "https://api.firecrawl.dev").replace(/\/$/, "");
if (this.isCloudService(apiUrl) && !apiKey) {
throw new Error("API key is required for the cloud API. Set FIRECRAWL_API_KEY env or pass apiKey.");
@@ -136,9 +142,9 @@ export class FirecrawlClient {
this.http = new HttpClient({
apiKey,
apiUrl,
- timeoutMs: options.timeoutMs,
- maxRetries: options.maxRetries,
- backoffFactor: options.backoffFactor,
+ timeoutMs: opts.timeoutMs,
+ maxRetries: opts.maxRetries,
+ backoffFactor: opts.backoffFactor,
});
}