Index (firecrawl-java 1.2.0 API)

A B C D E F G H I J L M O P R S T U W Z
All Classes All Packages

A

actions(List<Map<String, Object>>) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Actions to execute before/during scraping.
agent(AgentOptions) - Method in class com.firecrawl.client.FirecrawlClient: Runs an agent task and waits for completion (auto-polling).
agent(AgentOptions, int, int) - Method in class com.firecrawl.client.FirecrawlClient: Runs an agent task and waits for completion with custom polling settings.
agentAsync(AgentOptions) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously runs an agent task and waits for completion.
AgentOptions - Class in com.firecrawl.models: Options for starting an agent task.
AgentOptions.Builder - Class in com.firecrawl.models
AgentResponse - Class in com.firecrawl.models: Response from starting an agent task.
AgentResponse() - Constructor for class com.firecrawl.models.AgentResponse
AgentStatusResponse - Class in com.firecrawl.models: Status response for an agent task.
AgentStatusResponse() - Constructor for class com.firecrawl.models.AgentStatusResponse
allowExternalLinks(Boolean) - Method in class com.firecrawl.models.CrawlOptions.Builder: Follow external links.
allowSubdomains(Boolean) - Method in class com.firecrawl.models.CrawlOptions.Builder: Follow subdomains.
apiKey(String) - Method in class com.firecrawl.client.FirecrawlClient.Builder: Sets the API key.
apiUrl(String) - Method in class com.firecrawl.client.FirecrawlClient.Builder: Sets the API base URL.
appendToId(String) - Method in class com.firecrawl.models.BatchScrapeOptions.Builder: Append URLs to an existing batch job.
asyncExecutor(Executor) - Method in class com.firecrawl.client.FirecrawlClient.Builder: Sets a custom executor for async operations.
AuthenticationException - Exception in com.firecrawl.errors: Thrown when the API returns a 401 Unauthorized response.
AuthenticationException(String) - Constructor for exception com.firecrawl.errors.AuthenticationException
AuthenticationException(String, String, Object) - Constructor for exception com.firecrawl.errors.AuthenticationException

B

backoffFactor(double) - Method in class com.firecrawl.client.FirecrawlClient.Builder: Sets the exponential backoff factor in seconds.
batchScrape(List<String>, BatchScrapeOptions) - Method in class com.firecrawl.client.FirecrawlClient: Batch-scrapes URLs and waits for completion (auto-polling).
batchScrape(List<String>, BatchScrapeOptions, int, int) - Method in class com.firecrawl.client.FirecrawlClient: Batch-scrapes URLs and waits for completion with custom polling settings.
batchScrapeAsync(List<String>, BatchScrapeOptions) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously batch-scrapes URLs and waits for completion.
BatchScrapeJob - Class in com.firecrawl.models: Status and results of a batch scrape job.
BatchScrapeJob() - Constructor for class com.firecrawl.models.BatchScrapeJob
BatchScrapeOptions - Class in com.firecrawl.models: Options for a batch scrape job.
BatchScrapeOptions.Builder - Class in com.firecrawl.models
BatchScrapeResponse - Class in com.firecrawl.models: Response from starting an async batch scrape job.
BatchScrapeResponse() - Constructor for class com.firecrawl.models.BatchScrapeResponse
blockAds(Boolean) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Block advertisements during scraping.
browser() - Method in class com.firecrawl.client.FirecrawlClient: Creates a new browser session with default settings.
browser(Integer, Integer, Boolean) - Method in class com.firecrawl.client.FirecrawlClient: Creates a new browser session with options.
browserAsync(Integer, Integer, Boolean) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously creates a new browser session.
BrowserCreateResponse - Class in com.firecrawl.models: Response from creating a new browser session.
BrowserCreateResponse() - Constructor for class com.firecrawl.models.BrowserCreateResponse
BrowserDeleteResponse - Class in com.firecrawl.models: Response from deleting a browser session.
BrowserDeleteResponse() - Constructor for class com.firecrawl.models.BrowserDeleteResponse
browserExecute(String, String) - Method in class com.firecrawl.client.FirecrawlClient: Executes code in a browser session using the default language (bash).
browserExecute(String, String, String, Integer) - Method in class com.firecrawl.client.FirecrawlClient: Executes code in a browser session with options.
browserExecuteAsync(String, String, String, Integer) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously executes code in a browser session.
BrowserExecuteResponse - Class in com.firecrawl.models: Response from executing code in a browser session.
BrowserExecuteResponse() - Constructor for class com.firecrawl.models.BrowserExecuteResponse
BrowserListResponse - Class in com.firecrawl.models: Response from listing browser sessions.
BrowserListResponse() - Constructor for class com.firecrawl.models.BrowserListResponse
BrowserSession - Class in com.firecrawl.models: Represents a browser session's metadata.
BrowserSession() - Constructor for class com.firecrawl.models.BrowserSession
build() - Method in class com.firecrawl.client.FirecrawlClient.Builder
build() - Method in class com.firecrawl.models.AgentOptions.Builder
build() - Method in class com.firecrawl.models.BatchScrapeOptions.Builder
build() - Method in class com.firecrawl.models.CrawlOptions.Builder
build() - Method in class com.firecrawl.models.JsonFormat.Builder
build() - Method in class com.firecrawl.models.LocationConfig.Builder
build() - Method in class com.firecrawl.models.MapOptions.Builder
build() - Method in class com.firecrawl.models.ScrapeOptions.Builder
build() - Method in class com.firecrawl.models.SearchOptions.Builder
build() - Method in class com.firecrawl.models.WebhookConfig.Builder
builder() - Static method in class com.firecrawl.client.FirecrawlClient: Creates a new builder for constructing a FirecrawlClient.
builder() - Static method in class com.firecrawl.models.AgentOptions
builder() - Static method in class com.firecrawl.models.BatchScrapeOptions
builder() - Static method in class com.firecrawl.models.CrawlOptions
builder() - Static method in class com.firecrawl.models.JsonFormat
builder() - Static method in class com.firecrawl.models.LocationConfig
builder() - Static method in class com.firecrawl.models.MapOptions
builder() - Static method in class com.firecrawl.models.ScrapeOptions
builder() - Static method in class com.firecrawl.models.SearchOptions
builder() - Static method in class com.firecrawl.models.WebhookConfig

C

cancelAgent(String) - Method in class com.firecrawl.client.FirecrawlClient: Cancels a running agent task.
cancelBatchScrape(String) - Method in class com.firecrawl.client.FirecrawlClient: Cancels a running batch scrape job.
cancelCrawl(String) - Method in class com.firecrawl.client.FirecrawlClient: Cancels a running crawl job.
categories(List<Object>) - Method in class com.firecrawl.models.SearchOptions.Builder: Categories: "github", "research", "pdf".
com.firecrawl.client - package com.firecrawl.client
com.firecrawl.errors - package com.firecrawl.errors
com.firecrawl.models - package com.firecrawl.models
ConcurrencyCheck - Class in com.firecrawl.models: Current concurrency usage.
ConcurrencyCheck() - Constructor for class com.firecrawl.models.ConcurrencyCheck
country(String) - Method in class com.firecrawl.models.LocationConfig.Builder
crawl(String, CrawlOptions) - Method in class com.firecrawl.client.FirecrawlClient: Crawls a website and waits for completion (auto-polling).
crawl(String, CrawlOptions, int, int) - Method in class com.firecrawl.client.FirecrawlClient: Crawls a website and waits for completion with custom polling settings.
crawlAsync(String, CrawlOptions) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously crawls a website and waits for completion.
crawlAsync(String, CrawlOptions, int, int) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously crawls with custom polling settings.
crawlEntireDomain(Boolean) - Method in class com.firecrawl.models.CrawlOptions.Builder: Whether to crawl the entire domain.
CrawlJob - Class in com.firecrawl.models: Status and results of a crawl job.
CrawlJob() - Constructor for class com.firecrawl.models.CrawlJob
CrawlOptions - Class in com.firecrawl.models: Options for crawling a website.
CrawlOptions.Builder - Class in com.firecrawl.models
CrawlResponse - Class in com.firecrawl.models: Response from starting an async crawl job.
CrawlResponse() - Constructor for class com.firecrawl.models.CrawlResponse
CreditUsage - Class in com.firecrawl.models: Current credit usage information.
CreditUsage() - Constructor for class com.firecrawl.models.CreditUsage

D

deduplicateSimilarURLs(Boolean) - Method in class com.firecrawl.models.CrawlOptions.Builder: Deduplicate URLs that are similar.
delay(Integer) - Method in class com.firecrawl.models.CrawlOptions.Builder: Delay in milliseconds between requests.
deleteBrowser(String) - Method in class com.firecrawl.client.FirecrawlClient: Deletes a browser session.
deleteBrowserAsync(String) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously deletes a browser session.
deleteScrapeBrowser(String) - Method in class com.firecrawl.client.FirecrawlClient: Deprecated.
Use FirecrawlClient.stopInteractiveBrowser(String).
deleteScrapeBrowserAsync(String) - Method in class com.firecrawl.client.FirecrawlClient: Deprecated.
Use FirecrawlClient.stopInteractiveBrowserAsync(String).
Document - Class in com.firecrawl.models: A scraped document returned by scrape, crawl, and batch endpoints.
Document() - Constructor for class com.firecrawl.models.Document

E

events(List<String>) - Method in class com.firecrawl.models.WebhookConfig.Builder: Events to subscribe to.
excludePaths(List<String>) - Method in class com.firecrawl.models.CrawlOptions.Builder: URL path patterns to exclude from crawling.
excludeTags(List<String>) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Exclude content from these HTML tags.

F

FirecrawlClient - Class in com.firecrawl.client: Client for the Firecrawl v2 API.
FirecrawlClient.Builder - Class in com.firecrawl.client
FirecrawlException - Exception in com.firecrawl.errors: Base exception for all Firecrawl SDK errors.
FirecrawlException(String) - Constructor for exception com.firecrawl.errors.FirecrawlException
FirecrawlException(String, int) - Constructor for exception com.firecrawl.errors.FirecrawlException
FirecrawlException(String, int, String, Object) - Constructor for exception com.firecrawl.errors.FirecrawlException
FirecrawlException(String, Throwable) - Constructor for exception com.firecrawl.errors.FirecrawlException
formats(List<Object>) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Output formats to request.
fromEnv() - Static method in class com.firecrawl.client.FirecrawlClient: Creates a client from the FIRECRAWL_API_KEY environment variable.

G

getActions() - Method in class com.firecrawl.models.Document
getActions() - Method in class com.firecrawl.models.ScrapeOptions
getAgentStatus(String) - Method in class com.firecrawl.client.FirecrawlClient: Gets the status of an agent task.
getAllowExternalLinks() - Method in class com.firecrawl.models.CrawlOptions
getAllowSubdomains() - Method in class com.firecrawl.models.CrawlOptions
getAppendToId() - Method in class com.firecrawl.models.BatchScrapeOptions
getAttributes() - Method in class com.firecrawl.models.Document
getAudio() - Method in class com.firecrawl.models.Document
getBatchScrapeStatus(String) - Method in class com.firecrawl.client.FirecrawlClient: Gets the status and results of a batch scrape job.
getBillingPeriodEnd() - Method in class com.firecrawl.models.CreditUsage
getBillingPeriodStart() - Method in class com.firecrawl.models.CreditUsage
getBlockAds() - Method in class com.firecrawl.models.ScrapeOptions
getBranding() - Method in class com.firecrawl.models.Document
getCategories() - Method in class com.firecrawl.models.SearchOptions
getCdpUrl() - Method in class com.firecrawl.models.BrowserCreateResponse
getCdpUrl() - Method in class com.firecrawl.models.BrowserSession
getChangeTracking() - Method in class com.firecrawl.models.Document
getCompleted() - Method in class com.firecrawl.models.BatchScrapeJob
getCompleted() - Method in class com.firecrawl.models.CrawlJob
getConcurrency() - Method in class com.firecrawl.client.FirecrawlClient: Gets current concurrency usage.
getConcurrency() - Method in class com.firecrawl.models.ConcurrencyCheck
getCountry() - Method in class com.firecrawl.models.LocationConfig
getCrawlEntireDomain() - Method in class com.firecrawl.models.CrawlOptions
getCrawlErrors(String) - Method in class com.firecrawl.client.FirecrawlClient: Gets errors from a crawl job.
getCrawlStatus(String) - Method in class com.firecrawl.client.FirecrawlClient: Gets the status and results of a crawl job.
getCreatedAt() - Method in class com.firecrawl.models.BrowserSession
getCreditsBilled() - Method in class com.firecrawl.models.BrowserDeleteResponse
getCreditsUsed() - Method in class com.firecrawl.models.AgentStatusResponse
getCreditsUsed() - Method in class com.firecrawl.models.BatchScrapeJob
getCreditsUsed() - Method in class com.firecrawl.models.CrawlJob
getCreditUsage() - Method in class com.firecrawl.client.FirecrawlClient: Gets current credit usage.
getData() - Method in class com.firecrawl.models.AgentStatusResponse
getData() - Method in class com.firecrawl.models.BatchScrapeJob
getData() - Method in class com.firecrawl.models.CrawlJob
getDeduplicateSimilarURLs() - Method in class com.firecrawl.models.CrawlOptions
getDelay() - Method in class com.firecrawl.models.CrawlOptions
getDetails() - Method in exception com.firecrawl.errors.FirecrawlException: Additional error details from the API response, if any.
getError() - Method in class com.firecrawl.models.AgentResponse
getError() - Method in class com.firecrawl.models.AgentStatusResponse
getError() - Method in class com.firecrawl.models.BrowserCreateResponse
getError() - Method in class com.firecrawl.models.BrowserDeleteResponse
getError() - Method in class com.firecrawl.models.BrowserExecuteResponse
getError() - Method in class com.firecrawl.models.BrowserListResponse
getErrorCode() - Method in exception com.firecrawl.errors.FirecrawlException: Error code from the API response, if any.
getEvents() - Method in class com.firecrawl.models.WebhookConfig
getExcludePaths() - Method in class com.firecrawl.models.CrawlOptions
getExcludeTags() - Method in class com.firecrawl.models.ScrapeOptions
getExitCode() - Method in class com.firecrawl.models.BrowserExecuteResponse
getExpiresAt() - Method in class com.firecrawl.models.AgentStatusResponse
getExpiresAt() - Method in class com.firecrawl.models.BatchScrapeJob
getExpiresAt() - Method in class com.firecrawl.models.BrowserCreateResponse
getExpiresAt() - Method in class com.firecrawl.models.CrawlJob
getFormats() - Method in class com.firecrawl.models.ScrapeOptions
getHeaders() - Method in class com.firecrawl.models.ScrapeOptions
getHeaders() - Method in class com.firecrawl.models.WebhookConfig
getHtml() - Method in class com.firecrawl.models.Document
getId() - Method in class com.firecrawl.models.AgentResponse
getId() - Method in class com.firecrawl.models.BatchScrapeJob
getId() - Method in class com.firecrawl.models.BatchScrapeResponse
getId() - Method in class com.firecrawl.models.BrowserCreateResponse
getId() - Method in class com.firecrawl.models.BrowserSession
getId() - Method in class com.firecrawl.models.CrawlJob
getId() - Method in class com.firecrawl.models.CrawlResponse
getIdempotencyKey() - Method in class com.firecrawl.models.BatchScrapeOptions
getIgnoreInvalidURLs() - Method in class com.firecrawl.models.BatchScrapeOptions
getIgnoreInvalidURLs() - Method in class com.firecrawl.models.SearchOptions
getIgnoreQueryParameters() - Method in class com.firecrawl.models.CrawlOptions
getIgnoreQueryParameters() - Method in class com.firecrawl.models.MapOptions
getImages() - Method in class com.firecrawl.models.Document
getImages() - Method in class com.firecrawl.models.SearchData: Image search results.
getIncludePaths() - Method in class com.firecrawl.models.CrawlOptions
getIncludeSubdomains() - Method in class com.firecrawl.models.MapOptions
getIncludeTags() - Method in class com.firecrawl.models.ScrapeOptions
getIntegration() - Method in class com.firecrawl.models.AgentOptions
getIntegration() - Method in class com.firecrawl.models.BatchScrapeOptions
getIntegration() - Method in class com.firecrawl.models.CrawlOptions
getIntegration() - Method in class com.firecrawl.models.MapOptions
getIntegration() - Method in class com.firecrawl.models.ScrapeOptions
getIntegration() - Method in class com.firecrawl.models.SearchOptions
getInvalidURLs() - Method in class com.firecrawl.models.BatchScrapeResponse
getJobId() - Method in exception com.firecrawl.errors.JobTimeoutException: The ID of the timed-out job.
getJson() - Method in class com.firecrawl.models.Document
getKilled() - Method in class com.firecrawl.models.BrowserExecuteResponse
getLanguages() - Method in class com.firecrawl.models.LocationConfig
getLastActivity() - Method in class com.firecrawl.models.BrowserSession
getLimit() - Method in class com.firecrawl.models.CrawlOptions
getLimit() - Method in class com.firecrawl.models.MapOptions
getLimit() - Method in class com.firecrawl.models.SearchOptions
getLinks() - Method in class com.firecrawl.models.Document
getLinks() - Method in class com.firecrawl.models.MapData: Returns the discovered links, normalised so that every entry is a Map<String, Object> containing at least a "url" key.
getLiveViewUrl() - Method in class com.firecrawl.models.BrowserCreateResponse
getLiveViewUrl() - Method in class com.firecrawl.models.BrowserSession
getLocation() - Method in class com.firecrawl.models.MapOptions
getLocation() - Method in class com.firecrawl.models.ScrapeOptions
getLocation() - Method in class com.firecrawl.models.SearchOptions
getMarkdown() - Method in class com.firecrawl.models.Document
getMaxAge() - Method in class com.firecrawl.models.ScrapeOptions
getMaxConcurrency() - Method in class com.firecrawl.models.BatchScrapeOptions
getMaxConcurrency() - Method in class com.firecrawl.models.ConcurrencyCheck
getMaxConcurrency() - Method in class com.firecrawl.models.CrawlOptions
getMaxCredits() - Method in class com.firecrawl.models.AgentOptions
getMaxDiscoveryDepth() - Method in class com.firecrawl.models.CrawlOptions
getMetadata() - Method in class com.firecrawl.models.Document
getMetadata() - Method in class com.firecrawl.models.WebhookConfig
getMobile() - Method in class com.firecrawl.models.ScrapeOptions
getModel() - Method in class com.firecrawl.models.AgentOptions
getModel() - Method in class com.firecrawl.models.AgentStatusResponse
getNews() - Method in class com.firecrawl.models.SearchData: News search results.
getNext() - Method in class com.firecrawl.models.BatchScrapeJob
getNext() - Method in class com.firecrawl.models.CrawlJob
getOnlyMainContent() - Method in class com.firecrawl.models.ScrapeOptions
getOptions() - Method in class com.firecrawl.models.BatchScrapeOptions
getParsers() - Method in class com.firecrawl.models.ScrapeOptions
getPlanCredits() - Method in class com.firecrawl.models.CreditUsage
getPrompt() - Method in class com.firecrawl.models.AgentOptions
getPrompt() - Method in class com.firecrawl.models.CrawlOptions
getPrompt() - Method in class com.firecrawl.models.JsonFormat
getProxy() - Method in class com.firecrawl.models.ScrapeOptions
getRawHtml() - Method in class com.firecrawl.models.Document
getRegexOnFullURL() - Method in class com.firecrawl.models.CrawlOptions
getRemainingCredits() - Method in class com.firecrawl.models.CreditUsage
getRemoveBase64Images() - Method in class com.firecrawl.models.ScrapeOptions
getResult() - Method in class com.firecrawl.models.BrowserExecuteResponse
getSchema() - Method in class com.firecrawl.models.AgentOptions
getSchema() - Method in class com.firecrawl.models.JsonFormat
getScrapeOptions() - Method in class com.firecrawl.models.CrawlOptions
getScrapeOptions() - Method in class com.firecrawl.models.SearchOptions
getScreenshot() - Method in class com.firecrawl.models.Document
getSearch() - Method in class com.firecrawl.models.MapOptions
getSessionDurationMs() - Method in class com.firecrawl.models.BrowserDeleteResponse
getSessions() - Method in class com.firecrawl.models.BrowserListResponse
getSitemap() - Method in class com.firecrawl.models.CrawlOptions
getSitemap() - Method in class com.firecrawl.models.MapOptions: Sitemap mode: "only", "include", or "skip".
getSkipTlsVerification() - Method in class com.firecrawl.models.ScrapeOptions
getSources() - Method in class com.firecrawl.models.SearchOptions
getStatus() - Method in class com.firecrawl.models.AgentStatusResponse
getStatus() - Method in class com.firecrawl.models.BatchScrapeJob
getStatus() - Method in class com.firecrawl.models.BrowserSession
getStatus() - Method in class com.firecrawl.models.CrawlJob
getStatusCode() - Method in exception com.firecrawl.errors.FirecrawlException: HTTP status code (0 if not an HTTP error).
getStderr() - Method in class com.firecrawl.models.BrowserExecuteResponse
getStdout() - Method in class com.firecrawl.models.BrowserExecuteResponse
getStoreInCache() - Method in class com.firecrawl.models.ScrapeOptions
getStrictConstrainToURLs() - Method in class com.firecrawl.models.AgentOptions
getSummary() - Method in class com.firecrawl.models.Document
getTbs() - Method in class com.firecrawl.models.SearchOptions
getTimeout() - Method in class com.firecrawl.models.MapOptions
getTimeout() - Method in class com.firecrawl.models.ScrapeOptions
getTimeout() - Method in class com.firecrawl.models.SearchOptions
getTimeoutSeconds() - Method in exception com.firecrawl.errors.JobTimeoutException: The timeout in seconds that was exceeded.
getTotal() - Method in class com.firecrawl.models.BatchScrapeJob
getTotal() - Method in class com.firecrawl.models.CrawlJob
getType() - Method in class com.firecrawl.models.JsonFormat
getUrl() - Method in class com.firecrawl.models.BatchScrapeResponse
getUrl() - Method in class com.firecrawl.models.CrawlResponse
getUrl() - Method in class com.firecrawl.models.WebhookConfig
getUrls() - Method in class com.firecrawl.models.AgentOptions
getWaitFor() - Method in class com.firecrawl.models.ScrapeOptions
getWarning() - Method in class com.firecrawl.models.Document
getWeb() - Method in class com.firecrawl.models.SearchData: Web search results.
getWebhook() - Method in class com.firecrawl.models.AgentOptions
getWebhook() - Method in class com.firecrawl.models.BatchScrapeOptions
getWebhook() - Method in class com.firecrawl.models.CrawlOptions
getZeroDataRetention() - Method in class com.firecrawl.models.BatchScrapeOptions
getZeroDataRetention() - Method in class com.firecrawl.models.CrawlOptions

H

headers(Map<String, String>) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Custom HTTP headers to send with the request.
headers(Map<String, String>) - Method in class com.firecrawl.models.WebhookConfig.Builder
httpClient(OkHttpClient) - Method in class com.firecrawl.client.FirecrawlClient.Builder: Sets a pre-configured OkHttpClient instance.

I

idempotencyKey(String) - Method in class com.firecrawl.models.BatchScrapeOptions.Builder: Idempotency key to prevent duplicate batch jobs.
ignoreInvalidURLs(Boolean) - Method in class com.firecrawl.models.BatchScrapeOptions.Builder: Ignore invalid URLs instead of failing.
ignoreInvalidURLs(Boolean) - Method in class com.firecrawl.models.SearchOptions.Builder: Ignore invalid URLs in results.
ignoreQueryParameters(Boolean) - Method in class com.firecrawl.models.CrawlOptions.Builder: Ignore query parameters when deduplicating URLs.
ignoreQueryParameters(Boolean) - Method in class com.firecrawl.models.MapOptions.Builder: Ignore query parameters when deduplicating URLs.
includePaths(List<String>) - Method in class com.firecrawl.models.CrawlOptions.Builder: URL path patterns to include in crawling.
includeSubdomains(Boolean) - Method in class com.firecrawl.models.MapOptions.Builder: Include subdomains.
includeTags(List<String>) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Only include content from these HTML tags.
integration(String) - Method in class com.firecrawl.models.AgentOptions.Builder: Integration identifier.
integration(String) - Method in class com.firecrawl.models.BatchScrapeOptions.Builder: Integration identifier.
integration(String) - Method in class com.firecrawl.models.CrawlOptions.Builder: Integration identifier.
integration(String) - Method in class com.firecrawl.models.MapOptions.Builder: Integration identifier.
integration(String) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Integration identifier.
integration(String) - Method in class com.firecrawl.models.SearchOptions.Builder: Integration identifier.
interact(String, String) - Method in class com.firecrawl.client.FirecrawlClient: Interacts with the scrape-bound browser session for a scrape job.
interact(String, String, String, Integer) - Method in class com.firecrawl.client.FirecrawlClient: Interacts with the scrape-bound browser session for a scrape job.
interact(String, String, String, Integer, String) - Method in class com.firecrawl.client.FirecrawlClient: Interacts with the scrape-bound browser session for a scrape job.
interactAsync(String, String) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously executes code in a scrape-bound browser session.
interactAsync(String, String, String, Integer) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously executes code in a scrape-bound browser session.
interactAsync(String, String, String, Integer, String) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously executes code in a scrape-bound browser session.
isDone() - Method in class com.firecrawl.models.AgentStatusResponse
isDone() - Method in class com.firecrawl.models.BatchScrapeJob
isDone() - Method in class com.firecrawl.models.CrawlJob: Returns true if the job has finished (completed, failed, or cancelled).
isStreamWebView() - Method in class com.firecrawl.models.BrowserSession
isSuccess() - Method in class com.firecrawl.models.AgentResponse
isSuccess() - Method in class com.firecrawl.models.AgentStatusResponse
isSuccess() - Method in class com.firecrawl.models.BrowserCreateResponse
isSuccess() - Method in class com.firecrawl.models.BrowserDeleteResponse
isSuccess() - Method in class com.firecrawl.models.BrowserExecuteResponse
isSuccess() - Method in class com.firecrawl.models.BrowserListResponse

J

JobTimeoutException - Exception in com.firecrawl.errors: Thrown when an async job (crawl, batch, agent) does not complete within the specified timeout.
JobTimeoutException(String, int, String) - Constructor for exception com.firecrawl.errors.JobTimeoutException
JsonFormat - Class in com.firecrawl.models: JSON extraction format with optional schema and prompt.
JsonFormat.Builder - Class in com.firecrawl.models

L

languages(List<String>) - Method in class com.firecrawl.models.LocationConfig.Builder
limit(Integer) - Method in class com.firecrawl.models.CrawlOptions.Builder: Maximum number of pages to crawl.
limit(Integer) - Method in class com.firecrawl.models.MapOptions.Builder: Maximum number of URLs to return.
limit(Integer) - Method in class com.firecrawl.models.SearchOptions.Builder: Maximum number of results.
listBrowsers() - Method in class com.firecrawl.client.FirecrawlClient: Lists all browser sessions.
listBrowsers(String) - Method in class com.firecrawl.client.FirecrawlClient: Lists browser sessions with optional status filter.
listBrowsersAsync(String) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously lists browser sessions.
location(LocationConfig) - Method in class com.firecrawl.models.MapOptions.Builder: Geolocation configuration.
location(LocationConfig) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Geolocation configuration.
location(String) - Method in class com.firecrawl.models.SearchOptions.Builder: Location for search results (e.g., "US").
LocationConfig - Class in com.firecrawl.models: Geolocation configuration for requests.
LocationConfig.Builder - Class in com.firecrawl.models

M

map(String) - Method in class com.firecrawl.client.FirecrawlClient: Discovers URLs on a website.
map(String, MapOptions) - Method in class com.firecrawl.client.FirecrawlClient: Discovers URLs on a website with options.
mapAsync(String, MapOptions) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously runs a map operation.
MapData - Class in com.firecrawl.models: Result of a map operation containing discovered URLs.
MapData() - Constructor for class com.firecrawl.models.MapData
MapOptions - Class in com.firecrawl.models: Options for mapping (discovering URLs on) a website.
MapOptions.Builder - Class in com.firecrawl.models
maxAge(Long) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Use cached result if younger than this many milliseconds.
maxConcurrency(Integer) - Method in class com.firecrawl.models.BatchScrapeOptions.Builder: Max concurrent scrapes.
maxConcurrency(Integer) - Method in class com.firecrawl.models.CrawlOptions.Builder: Maximum concurrent requests.
maxCredits(Integer) - Method in class com.firecrawl.models.AgentOptions.Builder: Maximum credits to spend.
maxDiscoveryDepth(Integer) - Method in class com.firecrawl.models.CrawlOptions.Builder: Maximum depth to discover links.
maxRetries(int) - Method in class com.firecrawl.client.FirecrawlClient.Builder: Sets the maximum number of automatic retries for transient failures.
metadata(Map<String, String>) - Method in class com.firecrawl.models.WebhookConfig.Builder
mobile(Boolean) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Scrape as a mobile device.
model(String) - Method in class com.firecrawl.models.AgentOptions.Builder: Agent model: "spark-1-pro" or "spark-1-mini".

O

onlyMainContent(Boolean) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Only return the main content of the page, excluding navbars/footers.
options(ScrapeOptions) - Method in class com.firecrawl.models.BatchScrapeOptions.Builder: Scrape options applied to each URL.

P

parsers(List<Object>) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Parsers to use (e.g., "pdf" or {"type": "pdf", "maxPages": 10}).
prompt(String) - Method in class com.firecrawl.models.AgentOptions.Builder: Natural language prompt describing what data to find.
prompt(String) - Method in class com.firecrawl.models.CrawlOptions.Builder: Natural language prompt to guide crawling.
prompt(String) - Method in class com.firecrawl.models.JsonFormat.Builder: LLM prompt for extraction.
proxy(String) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Proxy mode: "basic", "stealth", "enhanced", "auto", or a custom proxy URL.

R

RateLimitException - Exception in com.firecrawl.errors: Thrown when the API returns a 429 Too Many Requests response.
RateLimitException(String) - Constructor for exception com.firecrawl.errors.RateLimitException
RateLimitException(String, String, Object) - Constructor for exception com.firecrawl.errors.RateLimitException
regexOnFullURL(Boolean) - Method in class com.firecrawl.models.CrawlOptions.Builder: Apply regex patterns to the full URL, not just the path.
removeBase64Images(Boolean) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Remove base64-encoded images from the response.

S

schema(Map<String, Object>) - Method in class com.firecrawl.models.AgentOptions.Builder: JSON Schema for structured output.
schema(Map<String, Object>) - Method in class com.firecrawl.models.JsonFormat.Builder: JSON Schema for structured extraction.
scrape(String) - Method in class com.firecrawl.client.FirecrawlClient: Scrapes a single URL and returns the document.
scrape(String, ScrapeOptions) - Method in class com.firecrawl.client.FirecrawlClient: Scrapes a single URL with options.
scrapeAsync(String, ScrapeOptions) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously scrapes a URL.
scrapeExecute(String, String) - Method in class com.firecrawl.client.FirecrawlClient: Deprecated.
Use FirecrawlClient.interact(String, String).
scrapeExecute(String, String, String, Integer) - Method in class com.firecrawl.client.FirecrawlClient: Deprecated.
Use FirecrawlClient.interact(String, String, String, Integer).
scrapeExecute(String, String, String, Integer, String) - Method in class com.firecrawl.client.FirecrawlClient: Deprecated.
Use FirecrawlClient.interact(String, String, String, Integer, String).
scrapeExecuteAsync(String, String) - Method in class com.firecrawl.client.FirecrawlClient: Deprecated.
Use FirecrawlClient.interactAsync(String, String).
scrapeExecuteAsync(String, String, String, Integer) - Method in class com.firecrawl.client.FirecrawlClient: Deprecated.
Use FirecrawlClient.interactAsync(String, String, String, Integer).
scrapeExecuteAsync(String, String, String, Integer, String) - Method in class com.firecrawl.client.FirecrawlClient: Deprecated.
Use FirecrawlClient.interactAsync(String, String, String, Integer, String).
scrapeOptions(ScrapeOptions) - Method in class com.firecrawl.models.CrawlOptions.Builder: Scrape options applied to each crawled page.
scrapeOptions(ScrapeOptions) - Method in class com.firecrawl.models.SearchOptions.Builder: Scrape options applied to search result pages.
ScrapeOptions - Class in com.firecrawl.models: Options for scraping a single URL.
ScrapeOptions.Builder - Class in com.firecrawl.models
search(String) - Method in class com.firecrawl.client.FirecrawlClient: Performs a web search.
search(String) - Method in class com.firecrawl.models.MapOptions.Builder: Filter discovered URLs by keyword.
search(String, SearchOptions) - Method in class com.firecrawl.client.FirecrawlClient: Performs a web search with options.
searchAsync(String, SearchOptions) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously runs a search.
SearchData - Class in com.firecrawl.models: Search results from the v2 search API.
SearchData() - Constructor for class com.firecrawl.models.SearchData
SearchOptions - Class in com.firecrawl.models: Options for a web search request.
SearchOptions.Builder - Class in com.firecrawl.models
setData(List<Document>) - Method in class com.firecrawl.models.BatchScrapeJob
setData(List<Document>) - Method in class com.firecrawl.models.CrawlJob
setImages(List<Map<String, Object>>) - Method in class com.firecrawl.models.SearchData
setNews(List<Map<String, Object>>) - Method in class com.firecrawl.models.SearchData
setWeb(List<Map<String, Object>>) - Method in class com.firecrawl.models.SearchData
sitemap(String) - Method in class com.firecrawl.models.CrawlOptions.Builder: Sitemap handling: "skip", "include", or "only".
sitemap(String) - Method in class com.firecrawl.models.MapOptions.Builder: Sitemap mode: "only", "include", or "skip".
skipTlsVerification(Boolean) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Skip TLS certificate verification.
sources(List<Object>) - Method in class com.firecrawl.models.SearchOptions.Builder: Source types: "web", "news", "images" as strings or {type: "web"} maps.
startAgent(AgentOptions) - Method in class com.firecrawl.client.FirecrawlClient: Starts an async agent task.
startBatchScrape(List<String>, BatchScrapeOptions) - Method in class com.firecrawl.client.FirecrawlClient: Starts an async batch scrape job.
startCrawl(String, CrawlOptions) - Method in class com.firecrawl.client.FirecrawlClient: Starts an async crawl job and returns immediately.
stopInteractiveBrowser(String) - Method in class com.firecrawl.client.FirecrawlClient: Stops the interactive browser session for a scrape job.
stopInteractiveBrowserAsync(String) - Method in class com.firecrawl.client.FirecrawlClient: Asynchronously deletes a scrape-bound browser session.
storeInCache(Boolean) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Whether to cache the result.
strictConstrainToURLs(Boolean) - Method in class com.firecrawl.models.AgentOptions.Builder: Don't navigate outside provided URLs.

T

tbs(String) - Method in class com.firecrawl.models.SearchOptions.Builder: Time-based search filter (e.g., "qdr:d" for past day, "qdr:w" for past week).
timeout(Integer) - Method in class com.firecrawl.models.MapOptions.Builder: Timeout in milliseconds.
timeout(Integer) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Timeout in milliseconds for the scrape request.
timeout(Integer) - Method in class com.firecrawl.models.SearchOptions.Builder: Timeout in milliseconds.
timeoutMs(long) - Method in class com.firecrawl.client.FirecrawlClient.Builder: Sets the HTTP request timeout in milliseconds.
toBuilder() - Method in class com.firecrawl.models.ScrapeOptions
toString() - Method in class com.firecrawl.models.AgentResponse
toString() - Method in class com.firecrawl.models.AgentStatusResponse
toString() - Method in class com.firecrawl.models.BatchScrapeJob
toString() - Method in class com.firecrawl.models.BatchScrapeResponse
toString() - Method in class com.firecrawl.models.BrowserCreateResponse
toString() - Method in class com.firecrawl.models.BrowserDeleteResponse
toString() - Method in class com.firecrawl.models.BrowserExecuteResponse
toString() - Method in class com.firecrawl.models.BrowserListResponse
toString() - Method in class com.firecrawl.models.BrowserSession
toString() - Method in class com.firecrawl.models.ConcurrencyCheck
toString() - Method in class com.firecrawl.models.CrawlJob
toString() - Method in class com.firecrawl.models.CrawlResponse
toString() - Method in class com.firecrawl.models.CreditUsage
toString() - Method in class com.firecrawl.models.Document
toString() - Method in class com.firecrawl.models.MapData
toString() - Method in class com.firecrawl.models.SearchData

U

url(String) - Method in class com.firecrawl.models.WebhookConfig.Builder
urls(List<String>) - Method in class com.firecrawl.models.AgentOptions.Builder: Optional URLs to constrain the agent to.

W

waitFor(Integer) - Method in class com.firecrawl.models.ScrapeOptions.Builder: Wait time in milliseconds before scraping (for JS rendering).
webhook(WebhookConfig) - Method in class com.firecrawl.models.AgentOptions.Builder: Webhook configuration.
webhook(Object) - Method in class com.firecrawl.models.BatchScrapeOptions.Builder: Webhook URL string or WebhookConfig object.
webhook(Object) - Method in class com.firecrawl.models.CrawlOptions.Builder: Webhook URL string or WebhookConfig object.
WebhookConfig - Class in com.firecrawl.models: Webhook configuration for async jobs.
WebhookConfig.Builder - Class in com.firecrawl.models

Z

zeroDataRetention(Boolean) - Method in class com.firecrawl.models.BatchScrapeOptions.Builder: Do not store any data on Firecrawl servers.
zeroDataRetention(Boolean) - Method in class com.firecrawl.models.CrawlOptions.Builder: Do not store any scraped data on Firecrawl servers.

A B C D E F G H I J L M O P R S T U W Z
All Classes All Packages