@mendable/firecrawl-js 4.38.0 → 4.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -2
- package/dist/{chunk-KSTNOGOD.js → chunk-OJ4YJQ4J.js} +1 -1
- package/dist/index.cjs +204 -17
- package/dist/index.d.cts +289 -7
- package/dist/index.d.ts +289 -7
- package/dist/index.js +203 -17
- package/dist/{package-OS7RONXY.js → package-F6O7J2XI.js} +1 -1
- package/package.json +1 -1
- package/pnpm-workspace.yaml +3 -2
- package/src/__tests__/e2e/v2/batch.test.ts +13 -11
- package/src/__tests__/e2e/v2/crawl.test.ts +24 -20
- package/src/__tests__/e2e/v2/extract.test.ts +32 -7
- package/src/__tests__/e2e/v2/map.test.ts +4 -3
- package/src/__tests__/e2e/v2/parse.test.ts +4 -3
- package/src/__tests__/e2e/v2/scrape.test.ts +10 -9
- package/src/__tests__/e2e/v2/search.test.ts +9 -8
- package/src/__tests__/e2e/v2/usage.test.ts +6 -5
- package/src/__tests__/e2e/v2/utils/rateLimit.ts +257 -0
- package/src/__tests__/e2e/v2/watcher.test.ts +4 -3
- package/src/__tests__/unit/v2/agent-effort-trace.unit.test.ts +1 -1
- package/src/__tests__/unit/v2/agent-thread.unit.test.ts +164 -0
- package/src/__tests__/unit/v2/e2eRateLimitRetry.test.ts +501 -0
- package/src/__tests__/unit/v2/extract.unit.test.ts +1 -1
- package/src/__tests__/unit/v2/scrapeAutoResume.test.ts +1 -1
- package/src/__tests__/unit/v2/search-country.unit.test.ts +32 -0
- package/src/__tests__/unit/v2/search-data-property.test.ts +1 -0
- package/src/__tests__/unit/v2/threat-protection.unit.test.ts +18 -1
- package/src/__tests__/unit/v2/tools.unit.test.ts +240 -0
- package/src/__tests__/unit/v2/v1-aliases.test.ts +1 -0
- package/src/v2/client.ts +52 -4
- package/src/v2/methods/agent.ts +23 -1
- package/src/v2/methods/research.ts +14 -8
- package/src/v2/methods/scrape.ts +3 -1
- package/src/v2/methods/search.ts +8 -1
- package/src/v2/methods/tools.ts +137 -0
- package/src/v2/types.ts +307 -35
- package/src/v2/utils/errorHandler.ts +19 -3
package/dist/index.d.ts
CHANGED
|
@@ -200,6 +200,8 @@ interface ScrapeOptions {
|
|
|
200
200
|
};
|
|
201
201
|
integration?: string;
|
|
202
202
|
origin?: string;
|
|
203
|
+
/** Include domain-matched Alexandria contracts for this URL in `tools`. Default off. */
|
|
204
|
+
domainTools?: boolean;
|
|
203
205
|
}
|
|
204
206
|
type RedactPIIEntity = "PERSON" | "EMAIL" | "PHONE" | "LOCATION" | "FINANCIAL" | "SECRET";
|
|
205
207
|
interface RedactPIIOptions {
|
|
@@ -549,6 +551,8 @@ interface Document {
|
|
|
549
551
|
pages?: PdfPage[];
|
|
550
552
|
/** Typed PDF layout blocks, present only when `parsers[].blocks` is true. */
|
|
551
553
|
blocks?: PdfPageBlocks[];
|
|
554
|
+
/** Present when `domainTools` discovered contracts matching this URL. */
|
|
555
|
+
tools?: DiscoveredTool[];
|
|
552
556
|
}
|
|
553
557
|
interface PaginationConfig {
|
|
554
558
|
/** When true (default), automatically follow `next` links and aggregate all documents. */
|
|
@@ -650,9 +654,121 @@ interface SearchResultImages {
|
|
|
650
654
|
position?: number;
|
|
651
655
|
}
|
|
652
656
|
interface SearchData {
|
|
657
|
+
warning?: string;
|
|
653
658
|
web?: Array<SearchResultWeb | Document>;
|
|
654
659
|
news?: Array<SearchResultNews | Document>;
|
|
655
660
|
images?: Array<SearchResultImages | Document>;
|
|
661
|
+
tools?: DiscoveredTool[];
|
|
662
|
+
}
|
|
663
|
+
/** A complete tool contract returned by semantic or contextual discovery. */
|
|
664
|
+
interface DiscoveredTool {
|
|
665
|
+
id?: string;
|
|
666
|
+
provider: string;
|
|
667
|
+
capability: string;
|
|
668
|
+
name: string;
|
|
669
|
+
description: string;
|
|
670
|
+
creditsCost: number;
|
|
671
|
+
perRecord: boolean;
|
|
672
|
+
options: Array<{
|
|
673
|
+
name: string;
|
|
674
|
+
type: string;
|
|
675
|
+
required?: boolean;
|
|
676
|
+
[key: string]: unknown;
|
|
677
|
+
}>;
|
|
678
|
+
requiresOneOf?: string[][];
|
|
679
|
+
response?: {
|
|
680
|
+
about?: string;
|
|
681
|
+
key?: string;
|
|
682
|
+
fields?: Array<{
|
|
683
|
+
name: string;
|
|
684
|
+
type: string;
|
|
685
|
+
[key: string]: unknown;
|
|
686
|
+
}>;
|
|
687
|
+
[key: string]: unknown;
|
|
688
|
+
};
|
|
689
|
+
examples?: Partial<Record<"javascript" | "python" | "curl", string>> & Record<string, string>;
|
|
690
|
+
example?: {
|
|
691
|
+
recordedAt: string;
|
|
692
|
+
request: Record<string, unknown>;
|
|
693
|
+
response: unknown;
|
|
694
|
+
};
|
|
695
|
+
label?: string;
|
|
696
|
+
whenToUse?: string;
|
|
697
|
+
returns?: unknown;
|
|
698
|
+
discovery?: unknown;
|
|
699
|
+
attribution?: unknown;
|
|
700
|
+
matchedBy?: Array<"semantic" | "domain">;
|
|
701
|
+
matchedUrls?: string[];
|
|
702
|
+
concept?: string;
|
|
703
|
+
cohorts?: string[];
|
|
704
|
+
similarity?: number;
|
|
705
|
+
}
|
|
706
|
+
interface FindToolsOptions {
|
|
707
|
+
urls?: string[];
|
|
708
|
+
providers?: string[];
|
|
709
|
+
categories?: string[];
|
|
710
|
+
groups?: string[];
|
|
711
|
+
capabilities?: string[];
|
|
712
|
+
level?: "providers" | "groups" | "tools";
|
|
713
|
+
expand?: Array<"options" | "response" | "examples">;
|
|
714
|
+
limit?: number;
|
|
715
|
+
offset?: number;
|
|
716
|
+
}
|
|
717
|
+
interface FindToolsData {
|
|
718
|
+
level: "providers" | "groups" | "tools";
|
|
719
|
+
items: Array<{
|
|
720
|
+
id: string;
|
|
721
|
+
name: string;
|
|
722
|
+
next?: AlexandriaCall;
|
|
723
|
+
execute?: Pick<AlexandriaCall, "provider" | "capability">;
|
|
724
|
+
[key: string]: unknown;
|
|
725
|
+
}>;
|
|
726
|
+
total: number;
|
|
727
|
+
next: AlexandriaCall | null;
|
|
728
|
+
}
|
|
729
|
+
interface AlexandriaScrapeRequest extends AlexandriaOptions {
|
|
730
|
+
alexandria: AlexandriaCall | AlexandriaCall[];
|
|
731
|
+
}
|
|
732
|
+
interface AlexandriaCall {
|
|
733
|
+
provider: string;
|
|
734
|
+
capability: string;
|
|
735
|
+
options?: Record<string, unknown>;
|
|
736
|
+
}
|
|
737
|
+
interface AlexandriaScrapeError {
|
|
738
|
+
code: string;
|
|
739
|
+
message: string;
|
|
740
|
+
status?: number;
|
|
741
|
+
/** Present when credits were captured before the failure. */
|
|
742
|
+
chargeId?: string;
|
|
743
|
+
}
|
|
744
|
+
type AlexandriaScrapeResult = {
|
|
745
|
+
provider: string;
|
|
746
|
+
capability: string;
|
|
747
|
+
creditsCost: number;
|
|
748
|
+
data: unknown;
|
|
749
|
+
records?: number;
|
|
750
|
+
upstreamStatus?: number;
|
|
751
|
+
recordedAt?: string;
|
|
752
|
+
error?: undefined;
|
|
753
|
+
[key: string]: unknown;
|
|
754
|
+
} | {
|
|
755
|
+
provider?: string;
|
|
756
|
+
capability?: string;
|
|
757
|
+
error: AlexandriaScrapeError;
|
|
758
|
+
[key: string]: unknown;
|
|
759
|
+
};
|
|
760
|
+
interface AlexandriaScrapeData {
|
|
761
|
+
scrapeId: string;
|
|
762
|
+
requestId: string;
|
|
763
|
+
alexandria: AlexandriaScrapeResult[];
|
|
764
|
+
creditsCost: number;
|
|
765
|
+
}
|
|
766
|
+
interface AlexandriaOptions {
|
|
767
|
+
/** Reuse this ID with the identical payload when retrying an execution. */
|
|
768
|
+
requestId?: string;
|
|
769
|
+
timeout?: number;
|
|
770
|
+
integration?: string;
|
|
771
|
+
origin?: string;
|
|
656
772
|
}
|
|
657
773
|
/**
|
|
658
774
|
* Narrows ordinary **web search**. A category does not switch `search()` to a
|
|
@@ -681,8 +797,10 @@ interface CategoryOption {
|
|
|
681
797
|
}
|
|
682
798
|
interface SearchRequest {
|
|
683
799
|
query: string;
|
|
684
|
-
|
|
685
|
-
|
|
800
|
+
/** Include domain-matched contracts in tools alongside semantic matches. */
|
|
801
|
+
domainTools?: boolean;
|
|
802
|
+
sources?: Array<"web" | "news" | "images" | "alexandria" | {
|
|
803
|
+
type: "web" | "news" | "images" | "alexandria";
|
|
686
804
|
}>;
|
|
687
805
|
/**
|
|
688
806
|
* Narrow web search by category. See {@link CategoryOption}.
|
|
@@ -698,6 +816,8 @@ interface SearchRequest {
|
|
|
698
816
|
limit?: number;
|
|
699
817
|
tbs?: string;
|
|
700
818
|
location?: string;
|
|
819
|
+
/** ISO 3166-1 alpha-2 country code used to geo-target the search results. */
|
|
820
|
+
country?: string;
|
|
701
821
|
ignoreInvalidURLs?: boolean;
|
|
702
822
|
timeout?: number;
|
|
703
823
|
/** Generate query-relevant highlights for search results. Defaults to true. */
|
|
@@ -1087,10 +1207,66 @@ interface ExtractResponse$1 {
|
|
|
1087
1207
|
expiresAt?: string;
|
|
1088
1208
|
creditsUsed?: number;
|
|
1089
1209
|
}
|
|
1210
|
+
/** Conversation mode for an agent run. Defaults to "extract" server-side. */
|
|
1211
|
+
type AgentMode = "extract" | "chat";
|
|
1212
|
+
/** Options forwarded verbatim to the agent; the server owns every default. */
|
|
1213
|
+
interface AgentExchangeOptions {
|
|
1214
|
+
enabled?: boolean;
|
|
1215
|
+
/** At most 5. */
|
|
1216
|
+
toolkits?: string[];
|
|
1217
|
+
maxCalls?: number;
|
|
1218
|
+
requireApproval?: boolean;
|
|
1219
|
+
/** Answers a pendingApproval from the previous turn of the thread. */
|
|
1220
|
+
approve?: {
|
|
1221
|
+
approvalId: string;
|
|
1222
|
+
callIds?: string[];
|
|
1223
|
+
always?: boolean;
|
|
1224
|
+
};
|
|
1225
|
+
decline?: {
|
|
1226
|
+
approvalId: string;
|
|
1227
|
+
};
|
|
1228
|
+
}
|
|
1229
|
+
/** Per-run summary reported on a status response. */
|
|
1230
|
+
interface AgentExchangeSummary {
|
|
1231
|
+
enabled: boolean;
|
|
1232
|
+
/** What the run resolved to after thread inheritance, not what it requested. */
|
|
1233
|
+
toolkits?: string[];
|
|
1234
|
+
requireApproval?: boolean;
|
|
1235
|
+
paidCalls: number;
|
|
1236
|
+
creditsUsed: number | null;
|
|
1237
|
+
}
|
|
1238
|
+
/** A follow-up the agent offers for the next turn of the thread. */
|
|
1239
|
+
interface AgentSuggestion {
|
|
1240
|
+
label: string;
|
|
1241
|
+
prompt: string;
|
|
1242
|
+
}
|
|
1243
|
+
/** A turn that ended waiting for the caller to allow or refuse paid calls. */
|
|
1244
|
+
interface PendingApproval {
|
|
1245
|
+
id: string;
|
|
1246
|
+
reason: string;
|
|
1247
|
+
calls: {
|
|
1248
|
+
id: string;
|
|
1249
|
+
provider: string;
|
|
1250
|
+
capability: string;
|
|
1251
|
+
input: Record<string, unknown>;
|
|
1252
|
+
more?: Record<string, unknown>[];
|
|
1253
|
+
creditsEstimate: number | null;
|
|
1254
|
+
}[];
|
|
1255
|
+
resolution: null | {
|
|
1256
|
+
approved: boolean;
|
|
1257
|
+
callIds: string[];
|
|
1258
|
+
always: boolean;
|
|
1259
|
+
byRunId: string;
|
|
1260
|
+
};
|
|
1261
|
+
}
|
|
1090
1262
|
interface AgentResponse {
|
|
1091
1263
|
success: boolean;
|
|
1092
1264
|
id: string;
|
|
1093
1265
|
error?: string;
|
|
1266
|
+
/** Thread this run belongs to; pass it back to continue the conversation. */
|
|
1267
|
+
threadId?: string;
|
|
1268
|
+
/** 1-based position of this run in its thread. */
|
|
1269
|
+
threadTurn?: number;
|
|
1094
1270
|
}
|
|
1095
1271
|
interface AgentStatusResponse {
|
|
1096
1272
|
success: boolean;
|
|
@@ -1110,6 +1286,46 @@ interface AgentStatusResponse {
|
|
|
1110
1286
|
effort?: "low" | "medium" | "high";
|
|
1111
1287
|
expiresAt: string;
|
|
1112
1288
|
creditsUsed?: number;
|
|
1289
|
+
threadId?: string;
|
|
1290
|
+
threadTurn?: number;
|
|
1291
|
+
mode?: AgentMode;
|
|
1292
|
+
/** Assistant text reply. Chat-mode runs answer here instead of in `data`. */
|
|
1293
|
+
message?: string;
|
|
1294
|
+
suggestions?: AgentSuggestion[];
|
|
1295
|
+
pendingApproval?: PendingApproval;
|
|
1296
|
+
exchange?: AgentExchangeSummary;
|
|
1297
|
+
}
|
|
1298
|
+
/** A single run of a thread, as returned by getAgentThread. */
|
|
1299
|
+
interface AgentThreadRun {
|
|
1300
|
+
id: string;
|
|
1301
|
+
turn: number;
|
|
1302
|
+
mode: AgentMode;
|
|
1303
|
+
prompt: string;
|
|
1304
|
+
urls?: string[];
|
|
1305
|
+
schema?: unknown;
|
|
1306
|
+
effort?: "low" | "medium" | "high";
|
|
1307
|
+
status: "processing" | "succeeded" | "failed" | "cancelled" | "refused" | "credit_limit_reached";
|
|
1308
|
+
createdAt: string;
|
|
1309
|
+
finishedAt: string | null;
|
|
1310
|
+
creditsUsed: number | null;
|
|
1311
|
+
message: string | null;
|
|
1312
|
+
/** Only present when the request asked for includeData. */
|
|
1313
|
+
data?: unknown;
|
|
1314
|
+
suggestions?: AgentSuggestion[] | null;
|
|
1315
|
+
pendingApproval?: PendingApproval | null;
|
|
1316
|
+
exchange?: AgentExchangeSummary | null;
|
|
1317
|
+
}
|
|
1318
|
+
interface AgentThread {
|
|
1319
|
+
id: string;
|
|
1320
|
+
createdAt: string;
|
|
1321
|
+
updatedAt: string;
|
|
1322
|
+
status: "idle" | "running";
|
|
1323
|
+
runs: AgentThreadRun[];
|
|
1324
|
+
}
|
|
1325
|
+
interface AgentThreadResponse {
|
|
1326
|
+
success: boolean;
|
|
1327
|
+
thread?: AgentThread;
|
|
1328
|
+
error?: string;
|
|
1113
1329
|
}
|
|
1114
1330
|
/** Reasoning effort for agent jobs. Every level runs spark-2. */
|
|
1115
1331
|
type AgentEffort = "low" | "medium" | "high";
|
|
@@ -1343,12 +1559,25 @@ interface ErrorDetails {
|
|
|
1343
1559
|
details?: Record<string, unknown>;
|
|
1344
1560
|
status?: number;
|
|
1345
1561
|
}
|
|
1562
|
+
/** An out-of-band step the API requires before the request can succeed. */
|
|
1563
|
+
interface RequiresAction {
|
|
1564
|
+
type: "accept_terms" | (string & {});
|
|
1565
|
+
terms?: string;
|
|
1566
|
+
version?: string;
|
|
1567
|
+
url?: string;
|
|
1568
|
+
}
|
|
1569
|
+
declare function parseRequiresAction(value: unknown): RequiresAction | undefined;
|
|
1346
1570
|
declare class SdkError extends Error {
|
|
1571
|
+
requestId?: string;
|
|
1347
1572
|
status?: number;
|
|
1348
1573
|
code?: string;
|
|
1349
1574
|
details?: unknown;
|
|
1350
1575
|
jobId?: string;
|
|
1351
|
-
|
|
1576
|
+
/** Present on exchange-mediated scrape failures that already captured credits. */
|
|
1577
|
+
chargeId?: string;
|
|
1578
|
+
/** Present when the API needs an out-of-band step first, such as accepting provider terms. */
|
|
1579
|
+
requiresAction?: RequiresAction;
|
|
1580
|
+
constructor(message: string, status?: number, code?: string, details?: unknown, jobId?: string, chargeId?: string, requiresAction?: RequiresAction);
|
|
1352
1581
|
}
|
|
1353
1582
|
declare class JobTimeoutError extends SdkError {
|
|
1354
1583
|
timeoutSeconds: number;
|
|
@@ -1505,7 +1734,14 @@ interface SimilarPapersResponse {
|
|
|
1505
1734
|
/** Human-readable note when no results are produced. */
|
|
1506
1735
|
note?: string | null;
|
|
1507
1736
|
}
|
|
1508
|
-
/**
|
|
1737
|
+
/**
|
|
1738
|
+
* Component scores; each field is present only when that signal contributed.
|
|
1739
|
+
*
|
|
1740
|
+
* @deprecated Use the developer index instead. The research index GitHub
|
|
1741
|
+
* search stops responding after 2026-11-03. The developer index does not
|
|
1742
|
+
* expose a score breakdown. See
|
|
1743
|
+
* https://docs.firecrawl.dev/features/developer.
|
|
1744
|
+
*/
|
|
1509
1745
|
interface GitHubScoreBreakdown {
|
|
1510
1746
|
rrf?: number;
|
|
1511
1747
|
semantic?: number;
|
|
@@ -1513,6 +1749,11 @@ interface GitHubScoreBreakdown {
|
|
|
1513
1749
|
fusion?: number;
|
|
1514
1750
|
rerank?: number;
|
|
1515
1751
|
}
|
|
1752
|
+
/**
|
|
1753
|
+
* @deprecated Use the developer index instead. The research index GitHub
|
|
1754
|
+
* search stops responding after 2026-11-03. See
|
|
1755
|
+
* https://docs.firecrawl.dev/features/developer.
|
|
1756
|
+
*/
|
|
1516
1757
|
interface GitHubSearchItem {
|
|
1517
1758
|
resultType?: "github_history" | "repo_readme" | "web";
|
|
1518
1759
|
/** `owner/name`; empty for web results whose URL is not a repo page. */
|
|
@@ -1534,9 +1775,18 @@ interface GitHubSearchItem {
|
|
|
1534
1775
|
contentMd?: string;
|
|
1535
1776
|
scores: GitHubScoreBreakdown;
|
|
1536
1777
|
}
|
|
1778
|
+
/**
|
|
1779
|
+
* @deprecated Use the developer index instead. The research index GitHub
|
|
1780
|
+
* search stops responding after 2026-11-03. See
|
|
1781
|
+
* https://docs.firecrawl.dev/features/developer.
|
|
1782
|
+
*/
|
|
1537
1783
|
interface GitHubSearchResponse {
|
|
1538
1784
|
success: boolean;
|
|
1539
1785
|
results: GitHubSearchItem[];
|
|
1786
|
+
/** Deprecation notice while the sunset window is live. */
|
|
1787
|
+
warnings?: string[];
|
|
1788
|
+
/** Replacement endpoint path, while the sunset window is live. */
|
|
1789
|
+
replacement?: string;
|
|
1540
1790
|
}
|
|
1541
1791
|
/** Options for `research.searchPapers`. */
|
|
1542
1792
|
interface SearchPapersOptions {
|
|
@@ -1571,7 +1821,13 @@ interface SimilarPapersOptions {
|
|
|
1571
1821
|
/** Additional seed paper reference(s), same format as `id`. */
|
|
1572
1822
|
anchor?: string[];
|
|
1573
1823
|
}
|
|
1574
|
-
/**
|
|
1824
|
+
/**
|
|
1825
|
+
* Options for `research.searchGithub`.
|
|
1826
|
+
*
|
|
1827
|
+
* @deprecated Use the developer index instead. The research index GitHub
|
|
1828
|
+
* search stops responding after 2026-11-03. See
|
|
1829
|
+
* https://docs.firecrawl.dev/features/developer.
|
|
1830
|
+
*/
|
|
1575
1831
|
interface SearchGithubOptions {
|
|
1576
1832
|
/** Number of results to return (1–100, default 20). */
|
|
1577
1833
|
k?: number;
|
|
@@ -1666,6 +1922,9 @@ declare function prepareAgentPayload(args: {
|
|
|
1666
1922
|
webhook?: string | AgentWebhookConfig;
|
|
1667
1923
|
threatProtection?: ThreatProtectionOptions;
|
|
1668
1924
|
auditMetadata?: AuditMetadata$1;
|
|
1925
|
+
threadId?: string;
|
|
1926
|
+
mode?: AgentMode;
|
|
1927
|
+
exchange?: AgentExchangeOptions;
|
|
1669
1928
|
}): Record<string, unknown>;
|
|
1670
1929
|
declare function startAgent(http: HttpClient, args: Parameters<typeof prepareAgentPayload>[0]): Promise<AgentResponse>;
|
|
1671
1930
|
|
|
@@ -1756,7 +2015,16 @@ declare class ResearchClient {
|
|
|
1756
2015
|
*/
|
|
1757
2016
|
similarPapers(id: string, options: SimilarPapersOptions): Promise<SimilarPapersResponse>;
|
|
1758
2017
|
/**
|
|
1759
|
-
* Search GitHub issue/PR history and repository
|
|
2018
|
+
* Search the research index GitHub slice: issue/PR history and repository
|
|
2019
|
+
* readmes.
|
|
2020
|
+
*
|
|
2021
|
+
* @deprecated Use `developerSearch()` on the client instead. This
|
|
2022
|
+
* endpoint stops responding after 2026-11-03. The developer index searches
|
|
2023
|
+
* GitHub issues, pull requests and readmes plus curated documentation
|
|
2024
|
+
* sources, returns matched passages, and adds filters for repo, language,
|
|
2025
|
+
* license and stars. It does not carry over the `scores` breakdown or the
|
|
2026
|
+
* `resultType: "web"` fallback results. See
|
|
2027
|
+
* https://docs.firecrawl.dev/features/developer.
|
|
1760
2028
|
* @param query Search query.
|
|
1761
2029
|
* @param options Optional `k`.
|
|
1762
2030
|
*/
|
|
@@ -1835,6 +2103,9 @@ declare class FirecrawlClient {
|
|
|
1835
2103
|
json?: InferredJsonFromOptions<Opts>;
|
|
1836
2104
|
}>;
|
|
1837
2105
|
scrape(url: string, options?: ScrapeCallOptions): Promise<Document>;
|
|
2106
|
+
scrape(request: AlexandriaScrapeRequest): Promise<AlexandriaScrapeData>;
|
|
2107
|
+
/** Explore the catalogue without executing the tools it returns. */
|
|
2108
|
+
findTools(options?: FindToolsOptions): Promise<FindToolsData>;
|
|
1838
2109
|
/**
|
|
1839
2110
|
* Interact with the browser session associated with a scrape job.
|
|
1840
2111
|
* @param jobId Scrape job id.
|
|
@@ -1903,6 +2174,9 @@ declare class FirecrawlClient {
|
|
|
1903
2174
|
* Access the v2 research endpoints — Firecrawl's **research paper index**
|
|
1904
2175
|
* (~43M paper abstracts) plus GitHub history/readmes.
|
|
1905
2176
|
*
|
|
2177
|
+
* `research.searchGithub()` is deprecated and stops responding after
|
|
2178
|
+
* 2026-11-03. Use `developerSearch()` instead.
|
|
2179
|
+
*
|
|
1906
2180
|
* The paper corpus is roughly 90% biomedical and life sciences — PubMed,
|
|
1907
2181
|
* bioRxiv and medRxiv — with arXiv covering physics, mathematics and
|
|
1908
2182
|
* computer science.
|
|
@@ -2105,6 +2379,14 @@ declare class FirecrawlClient {
|
|
|
2105
2379
|
* @param snapshotId Snapshot id from an artifact.updated trace event.
|
|
2106
2380
|
*/
|
|
2107
2381
|
getAgentSnapshot(jobId: string, snapshotId: string): Promise<AgentSnapshotResponse>;
|
|
2382
|
+
/**
|
|
2383
|
+
* Get a thread and its runs, oldest turn first.
|
|
2384
|
+
* @param threadId Thread id, as returned by startAgent or getAgentStatus.
|
|
2385
|
+
* @param options.includeData Inline each succeeded run's data.
|
|
2386
|
+
*/
|
|
2387
|
+
getAgentThread(threadId: string, options?: {
|
|
2388
|
+
includeData?: boolean;
|
|
2389
|
+
}): Promise<AgentThreadResponse>;
|
|
2108
2390
|
/**
|
|
2109
2391
|
* Create a new browser session.
|
|
2110
2392
|
* @param args Session options (ttl, activityTtl, streamWebView, profile).
|
|
@@ -3107,4 +3389,4 @@ declare class Firecrawl extends FirecrawlClient {
|
|
|
3107
3389
|
get v1(): FirecrawlApp;
|
|
3108
3390
|
}
|
|
3109
3391
|
|
|
3110
|
-
export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentEffort, type AgentListItem, type AgentListOptions, type AgentListResponse, 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 };
|
|
3392
|
+
export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentEffort, type AgentExchangeOptions, type AgentExchangeSummary, type AgentListItem, type AgentListOptions, type AgentListResponse, type AgentMode, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentSnapshotResponse, type AgentStatusResponse, type AgentSuggestion, type AgentThread, type AgentThreadResponse, type AgentThreadRun, 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 AlexandriaCall, type AlexandriaOptions, type AlexandriaScrapeData, type AlexandriaScrapeError, type AlexandriaScrapeRequest, type AlexandriaScrapeResult, 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 DiscoveredTool, 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, type FindToolsData, type FindToolsOptions, 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 PendingApproval, 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, type RequiresAction, 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, parseRequiresAction };
|