firecrawl 4.35.0 → 4.37.0

package/dist/{chunk-666CR5HH.js → chunk-LFX7WDGT.js}

@@ -12,7 +12,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.35.0",
+      version: "4.37.0",
       description: "JavaScript SDK for the Firecrawl API: web scraping, crawling, web search, and scientific literature search over a research paper index of PubMed, bioRxiv, medRxiv and arXiv abstracts",
       main: "dist/index.js",
       types: "dist/index.d.ts",

package/dist/index.cjs

@@ -39,7 +39,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.35.0",
+      version: "4.37.0",
       description: "JavaScript SDK for the Firecrawl API: web scraping, crawling, web search, and scientific literature search over a research paper index of PubMed, bioRxiv, medRxiv and arXiv abstracts",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -179,6 +179,11 @@ var HttpClient = class {
   getApiKey() {
     return this.apiKey;
   }
+  /** The client-wide default request timeout, for callers that need to
+   * extend a specific request beyond it (e.g. scrape auto-resume). */
+  getTimeoutMs() {
+    return this.instance.defaults.timeout ?? 3e5;
+  }
   async request(config) {
     const version = getVersion();
     config.headers = {
@@ -559,26 +564,60 @@ function isRetryableError(err) {
 }
 
 // src/v2/methods/scrape.ts
-async function scrape(http, url, options) {
+var RESUME_MAX_ATTEMPTS = 5;
+var RESUME_MAX_TOTAL_WAIT_MS = 20 * 60 * 1e3;
+var RESUME_MIN_DELAY_MS = 5 * 1e3;
+var RESUME_MAX_DELAY_MS = 10 * 60 * 1e3;
+function processingContinuesDelayMs(err) {
+  const response = err?.isAxiosError ? err.response : void 0;
+  if (!response || response.status !== 408) return void 0;
+  const body = response.data;
+  if (body?.code !== "SCRAPE_TIMEOUT" || body?.details?.state !== "processing_continues") {
+    return void 0;
+  }
+  const headerSeconds = Number(response.headers?.["retry-after"]);
+  const seconds = typeof body.details.retryAfterSeconds === "number" && Number.isFinite(body.details.retryAfterSeconds) ? body.details.retryAfterSeconds : Number.isFinite(headerSeconds) ? headerSeconds : 60;
+  return Math.min(RESUME_MAX_DELAY_MS, Math.max(RESUME_MIN_DELAY_MS, seconds * 1e3));
+}
+async function scrape(http, url, options, deps = {}) {
+  const sleep = deps.sleepImpl ?? ((ms) => new Promise((resolve) => setTimeout(resolve, ms)));
   if (!url || !url.trim()) {
     throw new Error("URL cannot be empty");
   }
   if (options) ensureValidScrapeOptions(options);
+  const { autoResume, ...requestOptions } = options ?? {};
   const payload = { url: url.trim() };
-  if (options) Object.assign(payload, options);
-  try {
-    const res = await http.post(
-      "/v2/scrape",
-      payload,
-      typeof options?.timeout === "number" ? { timeoutMs: options.timeout + 5e3 } : {}
-    );
-    if (res.status !== 200 || !res.data?.success) {
-      throwForBadResponse(res, "scrape");
+  Object.assign(payload, requestOptions);
+  const requestTimeout = autoResume === false ? typeof options?.timeout === "number" ? { timeoutMs: options.timeout + 5e3 } : {} : {
+    timeoutMs: Math.max(
+      typeof options?.timeout === "number" ? options.timeout : 3e5,
+      typeof http.getTimeoutMs === "function" ? http.getTimeoutMs() : 0
+    ) + 3e4
+  };
+  let resumes = 0;
+  let resumeWaitedMs = 0;
+  while (true) {
+    try {
+      const res = await http.post(
+        "/v2/scrape",
+        payload,
+        requestTimeout
+      );
+      if (res.status !== 200 || !res.data?.success) {
+        throwForBadResponse(res, "scrape");
+      }
+      return res.data.data || {};
+    } catch (err) {
+      const delayMs = autoResume !== false ? processingContinuesDelayMs(err) : void 0;
+      if (delayMs !== void 0 && resumes < RESUME_MAX_ATTEMPTS && resumeWaitedMs + delayMs <= RESUME_MAX_TOTAL_WAIT_MS) {
+        resumes += 1;
+        resumeWaitedMs += delayMs;
+        await sleep(delayMs);
+        continue;
+      }
+      if (err?.isAxiosError) return normalizeAxiosError(err, "scrape");
+      throw err;
     }
-    return res.data.data || {};
-  } catch (err) {
-    if (err?.isAxiosError) return normalizeAxiosError(err, "scrape");
-    throw err;
   }
 }
 async function interact(http, jobId, args) {
@@ -1326,6 +1365,7 @@ function prepareAgentPayload(args) {
   if (args.maxCredits !== null && args.maxCredits !== void 0) body.maxCredits = args.maxCredits;
   if (args.strictConstrainToURLs !== null && args.strictConstrainToURLs !== void 0) body.strictConstrainToURLs = args.strictConstrainToURLs;
   if (args.model !== null && args.model !== void 0) body.model = args.model;
+  if (args.effort !== null && args.effort !== void 0) body.effort = args.effort;
   if (args.webhook != null) body.webhook = args.webhook;
   if (args.threatProtection != null)
     body.threatProtection = args.threatProtection;
@@ -1369,6 +1409,27 @@ async function agent(http, args) {
   if (!jobId) return started;
   return waitAgent(http, jobId, args.pollInterval ?? 2, args.timeout);
 }
+async function getAgentTrace(http, jobId, options) {
+  try {
+    const query = options?.liveView ? "?liveView=true" : "";
+    const res = await http.get(`/v2/agent/${jobId}/trace${query}`);
+    if (res.status !== 200) throwForBadResponse(res, "agent trace");
+    return res.data;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "agent trace");
+    throw err;
+  }
+}
+async function getAgentSnapshot(http, jobId, snapshotId) {
+  try {
+    const res = await http.get(`/v2/agent/${jobId}/snapshots/${snapshotId}`);
+    if (res.status !== 200) throwForBadResponse(res, "agent snapshot");
+    return res.data;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "agent snapshot");
+    throw err;
+  }
+}
 async function cancelAgent(http, jobId) {
   try {
     const res = await http.delete(`/v2/agent/${jobId}`);
@@ -2370,6 +2431,22 @@ var FirecrawlClient = class {
   async cancelAgent(jobId) {
     return cancelAgent(this.http, jobId);
   }
+  /**
+   * Get the execution trace of an agent job (spark-2 runs only).
+   * @param jobId Agent job id.
+   * @param options.liveView Also include currently active browser sessions with live view URLs.
+   */
+  async getAgentTrace(jobId, options) {
+    return getAgentTrace(this.http, jobId, options);
+  }
+  /**
+   * Get the full content of an artifact snapshot referenced by a trace event.
+   * @param jobId Agent job id.
+   * @param snapshotId Snapshot id from an artifact.updated trace event.
+   */
+  async getAgentSnapshot(jobId, snapshotId) {
+    return getAgentSnapshot(this.http, jobId, snapshotId);
+  }
   // Browser
   /**
    * Create a new browser session.

package/dist/index.d.cts

@@ -16,6 +16,7 @@ interface JsonFormat extends Format {
     type: "json";
     prompt?: string;
     schema?: Record<string, unknown> | ZodTypeAny;
+    checkPromptInjection?: boolean;
 }
 interface ScreenshotFormat {
     type: "screenshot";
@@ -1102,9 +1103,140 @@ interface AgentStatusResponse {
      * names makes every future model a type error at the call site.
      */
     model?: "spark-1-pro" | "spark-1-mini" | "spark-2" | (string & {});
+    /**
+     * Reasoning effort the job ran with. Only set for runs that specified it;
+     * older rows and default runs have no effort.
+     */
+    effort?: "low" | "medium" | "high";
     expiresAt: string;
     creditsUsed?: number;
 }
+/** Reasoning effort for agent jobs. Every level runs spark-2. */
+type AgentEffort = "low" | "medium" | "high";
+type AgentTraceAgentRole = "orchestrator" | "subagent" | "browser" | "system";
+interface AgentTraceAgentIdentity {
+    id: string;
+    role: AgentTraceAgentRole;
+    name: string;
+    parentId?: string;
+}
+interface AgentTraceError {
+    code: "cancelled" | "credit_limit_reached" | "parent_finished" | "refused" | "internal";
+    source: "agent" | "tool" | "billing" | "system";
+    retryable: boolean;
+    message: string;
+}
+interface AgentTraceArtifactChange {
+    kind: "json" | "markdown" | "html" | "screenshot" | "text";
+    artifactId: string;
+    path?: string;
+    /** Fetch the full content via getAgentSnapshot(jobId, snapshotId). */
+    snapshotId: string;
+    change: "init" | "partial" | "append" | "modify" | "update";
+    changedFields?: string[];
+    itemCount?: number;
+    sourceToolCallId?: string;
+}
+interface AgentTraceEventBase {
+    schemaVersion: 1;
+    eventId: string;
+    runId: string;
+    occurredAt: string;
+    producerSequence: number;
+    agent: AgentTraceAgentIdentity;
+}
+interface AgentTraceRunStartedEvent extends AgentTraceEventBase {
+    type: "run.started";
+}
+interface AgentTraceRunCancelRequestedEvent extends AgentTraceEventBase {
+    type: "run.cancel_requested";
+    reason: "user";
+}
+interface AgentTraceRunFinishedEvent extends AgentTraceEventBase {
+    type: "run.finished";
+    outcome: "succeeded" | "failed" | "cancelled" | "refused" | "credit_limit_reached";
+    /** The canonical schema always writes this key (nullable), but older rows may omit it. */
+    error?: AgentTraceError | null;
+}
+interface AgentTraceAgentStartedEvent extends AgentTraceEventBase {
+    type: "agent.started";
+}
+interface AgentTraceAgentFinishedEvent extends AgentTraceEventBase {
+    type: "agent.finished";
+    outcome: "succeeded" | "failed" | "cancelled" | "refused";
+    durationMs: number;
+    /** The canonical schema always writes this key (nullable), but older rows may omit it. */
+    error?: AgentTraceError | null;
+}
+interface AgentTraceBrowserSessionStartedEvent extends AgentTraceEventBase {
+    type: "browser.session.started";
+    sessionId: string;
+}
+interface AgentTraceBrowserSessionFinishedEvent extends AgentTraceEventBase {
+    type: "browser.session.finished";
+    sessionId: string;
+    durationMs: number;
+}
+interface AgentTraceProgressReportedEvent extends AgentTraceEventBase {
+    type: "progress.reported";
+    phase: "planning" | "working" | "finalizing";
+    message: string;
+}
+interface AgentTraceReasoningSummaryEvent extends AgentTraceEventBase {
+    type: "reasoning.summary";
+    text: string;
+}
+interface AgentTraceToolCallStartedEvent extends AgentTraceEventBase {
+    type: "tool_call.started";
+    toolCallId: string;
+    toolName: string;
+    parameters: unknown;
+}
+interface AgentTraceToolCallFinishedEvent extends AgentTraceEventBase {
+    type: "tool_call.finished";
+    toolCallId: string;
+    toolName: string;
+    result: unknown;
+}
+interface AgentTraceArtifactUpdatedEvent extends AgentTraceEventBase {
+    type: "artifact.updated";
+    artifact: AgentTraceArtifactChange;
+}
+interface AgentTraceErrorOccurredEvent extends AgentTraceEventBase {
+    type: "error.occurred";
+    error: AgentTraceError;
+}
+/**
+ * One event in an agent job's trace. Mirrors the canonical event schema of
+ * the agent service (schemaVersion 1); `usage.recorded` events are withheld
+ * server-side and `agent.started` carries no model name.
+ */
+type AgentTraceEvent = AgentTraceRunStartedEvent | AgentTraceRunCancelRequestedEvent | AgentTraceRunFinishedEvent | AgentTraceAgentStartedEvent | AgentTraceAgentFinishedEvent | AgentTraceBrowserSessionStartedEvent | AgentTraceBrowserSessionFinishedEvent | AgentTraceProgressReportedEvent | AgentTraceReasoningSummaryEvent | AgentTraceToolCallStartedEvent | AgentTraceToolCallFinishedEvent | AgentTraceArtifactUpdatedEvent | AgentTraceErrorOccurredEvent;
+interface AgentTraceActiveBrowserSession {
+    id: string;
+    liveViewUrl: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+}
+interface AgentTraceResponse {
+    success: boolean;
+    id?: string;
+    events?: AgentTraceEvent[];
+    creditsUsed?: number;
+    /** Present only when the trace was requested with liveView: true. */
+    activeBrowserSessions?: AgentTraceActiveBrowserSession[];
+    error?: string;
+}
+interface AgentSnapshotResponse {
+    success: boolean;
+    id?: string;
+    snapshotId?: string;
+    /** Full artifact content as a JSON/string blob. */
+    snapshot?: string;
+    error?: string;
+}
 interface AgentOptions$1 {
     model: "FIRE-1" | "v3-beta";
 }
@@ -1424,6 +1556,9 @@ declare class HttpClient {
     constructor(options: HttpClientOptions);
     getApiUrl(): string;
     getApiKey(): string;
+    /** The client-wide default request timeout, for callers that need to
+     * extend a specific request beyond it (e.g. scrape auto-resume). */
+    getTimeoutMs(): number;
     private request;
     private sleep;
     post<T = any>(endpoint: string, body: Record<string, unknown>, options?: RequestOptions): Promise<AxiosResponse<T, any, {}>>;
@@ -1434,6 +1569,27 @@ declare class HttpClient {
     prepareHeaders(idempotencyKey?: string): Record<string, string>;
 }
 
+/**
+ * Options for a direct scrape call. `autoResume` lives here — NOT on the
+ * shared ScrapeOptions — because that type is reused verbatim inside
+ * batch/crawl/search/extract payloads, where an SDK-only key would leak
+ * onto the wire and fail strict endpoints.
+ */
+type ScrapeCallOptions = ScrapeOptions & {
+    /**
+     * SDK-only (never sent to the API). Large documents (big PDFs) that
+     * outlive the request window keep processing server-side; the API's
+     * timeout error then carries `details.state === "processing_continues"`
+     * and a Retry-After. When this is not `false`, the SDK sleeps that
+     * long and re-issues the same request — the retry attaches to the
+     * in-flight job and returns the finished result, so a large document
+     * behaves like one slow successful call. Bounded (at most 5 resumes /
+     * 20 minutes total wait); set `false` to surface the timeout error
+     * immediately instead.
+     */
+    autoResume?: boolean;
+};
+
 declare function prepareExtractPayload(args: {
     urls?: string[];
     prompt?: string;
@@ -1465,6 +1621,7 @@ declare function prepareAgentPayload(args: {
     maxCredits?: number;
     strictConstrainToURLs?: boolean;
     model?: "spark-1-pro" | "spark-1-mini" | "spark-2";
+    effort?: AgentEffort;
     webhook?: string | AgentWebhookConfig;
     threatProtection?: ThreatProtectionOptions;
     auditMetadata?: AuditMetadata$1;
@@ -1636,7 +1793,7 @@ declare class FirecrawlClient {
     scrape<Opts extends ScrapeOptions>(url: string, options: Opts): Promise<Omit<Document, "json"> & {
         json?: InferredJsonFromOptions<Opts>;
     }>;
-    scrape(url: string, options?: ScrapeOptions): Promise<Document>;
+    scrape(url: string, options?: ScrapeCallOptions): Promise<Document>;
     /**
      * Interact with the browser session associated with a scrape job.
      * @param jobId Scrape job id.
@@ -1884,6 +2041,20 @@ declare class FirecrawlClient {
      * @returns True if cancelled.
      */
     cancelAgent(jobId: string): Promise<boolean>;
+    /**
+     * Get the execution trace of an agent job (spark-2 runs only).
+     * @param jobId Agent job id.
+     * @param options.liveView Also include currently active browser sessions with live view URLs.
+     */
+    getAgentTrace(jobId: string, options?: {
+        liveView?: boolean;
+    }): Promise<AgentTraceResponse>;
+    /**
+     * Get the full content of an artifact snapshot referenced by a trace event.
+     * @param jobId Agent job id.
+     * @param snapshotId Snapshot id from an artifact.updated trace event.
+     */
+    getAgentSnapshot(jobId: string, snapshotId: string): Promise<AgentSnapshotResponse>;
     /**
      * Create a new browser session.
      * @param args Session options (ttl, activityTtl, streamWebView, profile).
@@ -2124,6 +2295,7 @@ interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema exten
         prompt?: string;
         schema?: LLMSchema;
         systemPrompt?: string;
+        checkPromptInjection?: boolean;
     };
     changeTrackingOptions?: {
         prompt?: string;
@@ -2885,4 +3057,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type AuditMetadata$1 as AuditMetadata, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type DeveloperSearchLicenseDisclosure, type DeveloperSearchOptions, type DeveloperSearchPassage, type DeveloperSearchRepoStatus, type DeveloperSearchResponse, type DeveloperSearchResult, type DeveloperSearchSourceStatus, type DeveloperSearchType, type Document, type DocumentMetadata, type EndpointFeedbackEndpoint, type EndpointFeedbackRequest, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, type FeedbackMissingContent, type FeedbackRating, type FeedbackResponse, type FeedbackValuableSource, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientInput, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type GetPaperOptions, type GitHubScoreBreakdown, type GitHubSearchItem, type GitHubSearchResponse, type HighlightsFormat, type IdMap, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type MenuAvailability, type MenuImage, type MenuItem, type MenuItemIdentifiers, type MenuMerchant, type MenuPrice, type MenuProfile, type MenuSection, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorCrawlTargetResult, type MonitorEmailNotification, type MonitorEmailRecipientSubscription, type MonitorJsonFieldDiff, type MonitorNotification, type MonitorPageDiff, type MonitorPageJudgment, type MonitorPageSnapshot, type MonitorSchedule, type MonitorScrapeTarget, type MonitorScrapeTargetResult, type MonitorSearchTarget, type MonitorSearchTargetResult, type MonitorSummary, type MonitorTarget, type MonitorTargetResult, type MonitorWebhookConfig, type PDFAction, type PDFParser, type PaginationConfig, type PaperMetadata, type PaperMetadataResponse, type PaperResult, type PaperSignals, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type Passage, type PdfBlockConfidence, type PdfBlockItem, type PdfPage, type PdfPageBlocks, type PressAction, type ProductAvailability, type ProductImage, type ProductPrice, type ProductProfile, type ProductSale, type ProductVariant, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ReadPaperResponse, type RedactPIIEntity, type RedactPIIOptions, ResearchClient, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchFeedbackRequest, type SearchGithubOptions, type SearchPapersOptions, type SearchPapersResponse, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type SimilarPapersOptions, type SimilarPapersResponse, type ThreatProtectionOptions, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentEffort, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentSnapshotResponse, type AgentStatusResponse, type AgentTraceActiveBrowserSession, type AgentTraceAgentFinishedEvent, type AgentTraceAgentIdentity, type AgentTraceAgentRole, type AgentTraceAgentStartedEvent, type AgentTraceArtifactChange, type AgentTraceArtifactUpdatedEvent, type AgentTraceBrowserSessionFinishedEvent, type AgentTraceBrowserSessionStartedEvent, type AgentTraceError, type AgentTraceErrorOccurredEvent, type AgentTraceEvent, type AgentTraceProgressReportedEvent, type AgentTraceReasoningSummaryEvent, type AgentTraceResponse, type AgentTraceRunCancelRequestedEvent, type AgentTraceRunFinishedEvent, type AgentTraceRunStartedEvent, type AgentTraceToolCallFinishedEvent, type AgentTraceToolCallStartedEvent, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type AuditMetadata$1 as AuditMetadata, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type DeveloperSearchLicenseDisclosure, type DeveloperSearchOptions, type DeveloperSearchPassage, type DeveloperSearchRepoStatus, type DeveloperSearchResponse, type DeveloperSearchResult, type DeveloperSearchSourceStatus, type DeveloperSearchType, type Document, type DocumentMetadata, type EndpointFeedbackEndpoint, type EndpointFeedbackRequest, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, type FeedbackMissingContent, type FeedbackRating, type FeedbackResponse, type FeedbackValuableSource, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientInput, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type GetPaperOptions, type GitHubScoreBreakdown, type GitHubSearchItem, type GitHubSearchResponse, type HighlightsFormat, type IdMap, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type MenuAvailability, type MenuImage, type MenuItem, type MenuItemIdentifiers, type MenuMerchant, type MenuPrice, type MenuProfile, type MenuSection, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorCrawlTargetResult, type MonitorEmailNotification, type MonitorEmailRecipientSubscription, type MonitorJsonFieldDiff, type MonitorNotification, type MonitorPageDiff, type MonitorPageJudgment, type MonitorPageSnapshot, type MonitorSchedule, type MonitorScrapeTarget, type MonitorScrapeTargetResult, type MonitorSearchTarget, type MonitorSearchTargetResult, type MonitorSummary, type MonitorTarget, type MonitorTargetResult, type MonitorWebhookConfig, type PDFAction, type PDFParser, type PaginationConfig, type PaperMetadata, type PaperMetadataResponse, type PaperResult, type PaperSignals, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type Passage, type PdfBlockConfidence, type PdfBlockItem, type PdfPage, type PdfPageBlocks, type PressAction, type ProductAvailability, type ProductImage, type ProductPrice, type ProductProfile, type ProductSale, type ProductVariant, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ReadPaperResponse, type RedactPIIEntity, type RedactPIIOptions, ResearchClient, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchFeedbackRequest, type SearchGithubOptions, type SearchPapersOptions, type SearchPapersResponse, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type SimilarPapersOptions, type SimilarPapersResponse, type ThreatProtectionOptions, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };

package/dist/index.d.ts

@@ -16,6 +16,7 @@ interface JsonFormat extends Format {
     type: "json";
     prompt?: string;
     schema?: Record<string, unknown> | ZodTypeAny;
+    checkPromptInjection?: boolean;
 }
 interface ScreenshotFormat {
     type: "screenshot";
@@ -1102,9 +1103,140 @@ interface AgentStatusResponse {
      * names makes every future model a type error at the call site.
      */
     model?: "spark-1-pro" | "spark-1-mini" | "spark-2" | (string & {});
+    /**
+     * Reasoning effort the job ran with. Only set for runs that specified it;
+     * older rows and default runs have no effort.
+     */
+    effort?: "low" | "medium" | "high";
     expiresAt: string;
     creditsUsed?: number;
 }
+/** Reasoning effort for agent jobs. Every level runs spark-2. */
+type AgentEffort = "low" | "medium" | "high";
+type AgentTraceAgentRole = "orchestrator" | "subagent" | "browser" | "system";
+interface AgentTraceAgentIdentity {
+    id: string;
+    role: AgentTraceAgentRole;
+    name: string;
+    parentId?: string;
+}
+interface AgentTraceError {
+    code: "cancelled" | "credit_limit_reached" | "parent_finished" | "refused" | "internal";
+    source: "agent" | "tool" | "billing" | "system";
+    retryable: boolean;
+    message: string;
+}
+interface AgentTraceArtifactChange {
+    kind: "json" | "markdown" | "html" | "screenshot" | "text";
+    artifactId: string;
+    path?: string;
+    /** Fetch the full content via getAgentSnapshot(jobId, snapshotId). */
+    snapshotId: string;
+    change: "init" | "partial" | "append" | "modify" | "update";
+    changedFields?: string[];
+    itemCount?: number;
+    sourceToolCallId?: string;
+}
+interface AgentTraceEventBase {
+    schemaVersion: 1;
+    eventId: string;
+    runId: string;
+    occurredAt: string;
+    producerSequence: number;
+    agent: AgentTraceAgentIdentity;
+}
+interface AgentTraceRunStartedEvent extends AgentTraceEventBase {
+    type: "run.started";
+}
+interface AgentTraceRunCancelRequestedEvent extends AgentTraceEventBase {
+    type: "run.cancel_requested";
+    reason: "user";
+}
+interface AgentTraceRunFinishedEvent extends AgentTraceEventBase {
+    type: "run.finished";
+    outcome: "succeeded" | "failed" | "cancelled" | "refused" | "credit_limit_reached";
+    /** The canonical schema always writes this key (nullable), but older rows may omit it. */
+    error?: AgentTraceError | null;
+}
+interface AgentTraceAgentStartedEvent extends AgentTraceEventBase {
+    type: "agent.started";
+}
+interface AgentTraceAgentFinishedEvent extends AgentTraceEventBase {
+    type: "agent.finished";
+    outcome: "succeeded" | "failed" | "cancelled" | "refused";
+    durationMs: number;
+    /** The canonical schema always writes this key (nullable), but older rows may omit it. */
+    error?: AgentTraceError | null;
+}
+interface AgentTraceBrowserSessionStartedEvent extends AgentTraceEventBase {
+    type: "browser.session.started";
+    sessionId: string;
+}
+interface AgentTraceBrowserSessionFinishedEvent extends AgentTraceEventBase {
+    type: "browser.session.finished";
+    sessionId: string;
+    durationMs: number;
+}
+interface AgentTraceProgressReportedEvent extends AgentTraceEventBase {
+    type: "progress.reported";
+    phase: "planning" | "working" | "finalizing";
+    message: string;
+}
+interface AgentTraceReasoningSummaryEvent extends AgentTraceEventBase {
+    type: "reasoning.summary";
+    text: string;
+}
+interface AgentTraceToolCallStartedEvent extends AgentTraceEventBase {
+    type: "tool_call.started";
+    toolCallId: string;
+    toolName: string;
+    parameters: unknown;
+}
+interface AgentTraceToolCallFinishedEvent extends AgentTraceEventBase {
+    type: "tool_call.finished";
+    toolCallId: string;
+    toolName: string;
+    result: unknown;
+}
+interface AgentTraceArtifactUpdatedEvent extends AgentTraceEventBase {
+    type: "artifact.updated";
+    artifact: AgentTraceArtifactChange;
+}
+interface AgentTraceErrorOccurredEvent extends AgentTraceEventBase {
+    type: "error.occurred";
+    error: AgentTraceError;
+}
+/**
+ * One event in an agent job's trace. Mirrors the canonical event schema of
+ * the agent service (schemaVersion 1); `usage.recorded` events are withheld
+ * server-side and `agent.started` carries no model name.
+ */
+type AgentTraceEvent = AgentTraceRunStartedEvent | AgentTraceRunCancelRequestedEvent | AgentTraceRunFinishedEvent | AgentTraceAgentStartedEvent | AgentTraceAgentFinishedEvent | AgentTraceBrowserSessionStartedEvent | AgentTraceBrowserSessionFinishedEvent | AgentTraceProgressReportedEvent | AgentTraceReasoningSummaryEvent | AgentTraceToolCallStartedEvent | AgentTraceToolCallFinishedEvent | AgentTraceArtifactUpdatedEvent | AgentTraceErrorOccurredEvent;
+interface AgentTraceActiveBrowserSession {
+    id: string;
+    liveViewUrl: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+}
+interface AgentTraceResponse {
+    success: boolean;
+    id?: string;
+    events?: AgentTraceEvent[];
+    creditsUsed?: number;
+    /** Present only when the trace was requested with liveView: true. */
+    activeBrowserSessions?: AgentTraceActiveBrowserSession[];
+    error?: string;
+}
+interface AgentSnapshotResponse {
+    success: boolean;
+    id?: string;
+    snapshotId?: string;
+    /** Full artifact content as a JSON/string blob. */
+    snapshot?: string;
+    error?: string;
+}
 interface AgentOptions$1 {
     model: "FIRE-1" | "v3-beta";
 }
@@ -1424,6 +1556,9 @@ declare class HttpClient {
     constructor(options: HttpClientOptions);
     getApiUrl(): string;
     getApiKey(): string;
+    /** The client-wide default request timeout, for callers that need to
+     * extend a specific request beyond it (e.g. scrape auto-resume). */
+    getTimeoutMs(): number;
     private request;
     private sleep;
     post<T = any>(endpoint: string, body: Record<string, unknown>, options?: RequestOptions): Promise<AxiosResponse<T, any, {}>>;
@@ -1434,6 +1569,27 @@ declare class HttpClient {
     prepareHeaders(idempotencyKey?: string): Record<string, string>;
 }
 
+/**
+ * Options for a direct scrape call. `autoResume` lives here — NOT on the
+ * shared ScrapeOptions — because that type is reused verbatim inside
+ * batch/crawl/search/extract payloads, where an SDK-only key would leak
+ * onto the wire and fail strict endpoints.
+ */
+type ScrapeCallOptions = ScrapeOptions & {
+    /**
+     * SDK-only (never sent to the API). Large documents (big PDFs) that
+     * outlive the request window keep processing server-side; the API's
+     * timeout error then carries `details.state === "processing_continues"`
+     * and a Retry-After. When this is not `false`, the SDK sleeps that
+     * long and re-issues the same request — the retry attaches to the
+     * in-flight job and returns the finished result, so a large document
+     * behaves like one slow successful call. Bounded (at most 5 resumes /
+     * 20 minutes total wait); set `false` to surface the timeout error
+     * immediately instead.
+     */
+    autoResume?: boolean;
+};
+
 declare function prepareExtractPayload(args: {
     urls?: string[];
     prompt?: string;
@@ -1465,6 +1621,7 @@ declare function prepareAgentPayload(args: {
     maxCredits?: number;
     strictConstrainToURLs?: boolean;
     model?: "spark-1-pro" | "spark-1-mini" | "spark-2";
+    effort?: AgentEffort;
     webhook?: string | AgentWebhookConfig;
     threatProtection?: ThreatProtectionOptions;
     auditMetadata?: AuditMetadata$1;
@@ -1636,7 +1793,7 @@ declare class FirecrawlClient {
     scrape<Opts extends ScrapeOptions>(url: string, options: Opts): Promise<Omit<Document, "json"> & {
         json?: InferredJsonFromOptions<Opts>;
     }>;
-    scrape(url: string, options?: ScrapeOptions): Promise<Document>;
+    scrape(url: string, options?: ScrapeCallOptions): Promise<Document>;
     /**
      * Interact with the browser session associated with a scrape job.
      * @param jobId Scrape job id.
@@ -1884,6 +2041,20 @@ declare class FirecrawlClient {
      * @returns True if cancelled.
      */
     cancelAgent(jobId: string): Promise<boolean>;
+    /**
+     * Get the execution trace of an agent job (spark-2 runs only).
+     * @param jobId Agent job id.
+     * @param options.liveView Also include currently active browser sessions with live view URLs.
+     */
+    getAgentTrace(jobId: string, options?: {
+        liveView?: boolean;
+    }): Promise<AgentTraceResponse>;
+    /**
+     * Get the full content of an artifact snapshot referenced by a trace event.
+     * @param jobId Agent job id.
+     * @param snapshotId Snapshot id from an artifact.updated trace event.
+     */
+    getAgentSnapshot(jobId: string, snapshotId: string): Promise<AgentSnapshotResponse>;
     /**
      * Create a new browser session.
      * @param args Session options (ttl, activityTtl, streamWebView, profile).
@@ -2124,6 +2295,7 @@ interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema exten
         prompt?: string;
         schema?: LLMSchema;
         systemPrompt?: string;
+        checkPromptInjection?: boolean;
     };
     changeTrackingOptions?: {
         prompt?: string;
@@ -2885,4 +3057,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type AuditMetadata$1 as AuditMetadata, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type DeveloperSearchLicenseDisclosure, type DeveloperSearchOptions, type DeveloperSearchPassage, type DeveloperSearchRepoStatus, type DeveloperSearchResponse, type DeveloperSearchResult, type DeveloperSearchSourceStatus, type DeveloperSearchType, type Document, type DocumentMetadata, type EndpointFeedbackEndpoint, type EndpointFeedbackRequest, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, type FeedbackMissingContent, type FeedbackRating, type FeedbackResponse, type FeedbackValuableSource, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientInput, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type GetPaperOptions, type GitHubScoreBreakdown, type GitHubSearchItem, type GitHubSearchResponse, type HighlightsFormat, type IdMap, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type MenuAvailability, type MenuImage, type MenuItem, type MenuItemIdentifiers, type MenuMerchant, type MenuPrice, type MenuProfile, type MenuSection, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorCrawlTargetResult, type MonitorEmailNotification, type MonitorEmailRecipientSubscription, type MonitorJsonFieldDiff, type MonitorNotification, type MonitorPageDiff, type MonitorPageJudgment, type MonitorPageSnapshot, type MonitorSchedule, type MonitorScrapeTarget, type MonitorScrapeTargetResult, type MonitorSearchTarget, type MonitorSearchTargetResult, type MonitorSummary, type MonitorTarget, type MonitorTargetResult, type MonitorWebhookConfig, type PDFAction, type PDFParser, type PaginationConfig, type PaperMetadata, type PaperMetadataResponse, type PaperResult, type PaperSignals, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type Passage, type PdfBlockConfidence, type PdfBlockItem, type PdfPage, type PdfPageBlocks, type PressAction, type ProductAvailability, type ProductImage, type ProductPrice, type ProductProfile, type ProductSale, type ProductVariant, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ReadPaperResponse, type RedactPIIEntity, type RedactPIIOptions, ResearchClient, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchFeedbackRequest, type SearchGithubOptions, type SearchPapersOptions, type SearchPapersResponse, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type SimilarPapersOptions, type SimilarPapersResponse, type ThreatProtectionOptions, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentEffort, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentSnapshotResponse, type AgentStatusResponse, type AgentTraceActiveBrowserSession, type AgentTraceAgentFinishedEvent, type AgentTraceAgentIdentity, type AgentTraceAgentRole, type AgentTraceAgentStartedEvent, type AgentTraceArtifactChange, type AgentTraceArtifactUpdatedEvent, type AgentTraceBrowserSessionFinishedEvent, type AgentTraceBrowserSessionStartedEvent, type AgentTraceError, type AgentTraceErrorOccurredEvent, type AgentTraceEvent, type AgentTraceProgressReportedEvent, type AgentTraceReasoningSummaryEvent, type AgentTraceResponse, type AgentTraceRunCancelRequestedEvent, type AgentTraceRunFinishedEvent, type AgentTraceRunStartedEvent, type AgentTraceToolCallFinishedEvent, type AgentTraceToolCallStartedEvent, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type AuditMetadata$1 as AuditMetadata, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type DeveloperSearchLicenseDisclosure, type DeveloperSearchOptions, type DeveloperSearchPassage, type DeveloperSearchRepoStatus, type DeveloperSearchResponse, type DeveloperSearchResult, type DeveloperSearchSourceStatus, type DeveloperSearchType, type Document, type DocumentMetadata, type EndpointFeedbackEndpoint, type EndpointFeedbackRequest, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, type FeedbackMissingContent, type FeedbackRating, type FeedbackResponse, type FeedbackValuableSource, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientInput, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type GetPaperOptions, type GitHubScoreBreakdown, type GitHubSearchItem, type GitHubSearchResponse, type HighlightsFormat, type IdMap, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type MenuAvailability, type MenuImage, type MenuItem, type MenuItemIdentifiers, type MenuMerchant, type MenuPrice, type MenuProfile, type MenuSection, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorCrawlTargetResult, type MonitorEmailNotification, type MonitorEmailRecipientSubscription, type MonitorJsonFieldDiff, type MonitorNotification, type MonitorPageDiff, type MonitorPageJudgment, type MonitorPageSnapshot, type MonitorSchedule, type MonitorScrapeTarget, type MonitorScrapeTargetResult, type MonitorSearchTarget, type MonitorSearchTargetResult, type MonitorSummary, type MonitorTarget, type MonitorTargetResult, type MonitorWebhookConfig, type PDFAction, type PDFParser, type PaginationConfig, type PaperMetadata, type PaperMetadataResponse, type PaperResult, type PaperSignals, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type Passage, type PdfBlockConfidence, type PdfBlockItem, type PdfPage, type PdfPageBlocks, type PressAction, type ProductAvailability, type ProductImage, type ProductPrice, type ProductProfile, type ProductSale, type ProductVariant, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ReadPaperResponse, type RedactPIIEntity, type RedactPIIOptions, ResearchClient, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchFeedbackRequest, type SearchGithubOptions, type SearchPapersOptions, type SearchPapersResponse, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type SimilarPapersOptions, type SimilarPapersResponse, type ThreatProtectionOptions, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };