Skip to content

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

feat(java-sdk): support user-provided OkHttpClient instance

firecrawl-spring[bot]feb3b3a20668
diff --git a/apps/java-sdk/README.md b/apps/java-sdk/README.md
index 6fc05e944..8c776d60f 100644
--- a/apps/java-sdk/README.md
+++ b/apps/java-sdk/README.md
@@ -82,13 +82,13 @@ Before using the Java SDK, ensure you have the following installed:
### Gradle (Kotlin DSL)
```kotlin
-implementation("com.firecrawl:firecrawl-java:1.0.0")
+implementation("com.firecrawl:firecrawl-java:1.1.0")
```
### Gradle (Groovy)
```groovy
-implementation 'com.firecrawl:firecrawl-java:1.0.0'
+implementation 'com.firecrawl:firecrawl-java:1.1.0'
```
### Maven
@@ -97,7 +97,7 @@ implementation 'com.firecrawl:firecrawl-java:1.0.0'
<dependency>
<groupId>com.firecrawl</groupId>
<artifactId>firecrawl-java</artifactId>
- <version>1.0.0</version>
+ <version>1.1.0</version>
</dependency>
```
@@ -350,14 +350,14 @@ gradle build
```bash
gradle jar
-# Output: build/libs/firecrawl-java-1.0.0.jar
+# Output: build/libs/firecrawl-java-1.1.0.jar
```
### Install Locally
```bash
gradle publishToMavenLocal
-# Now available as: com.firecrawl:firecrawl-java:1.0.0 in local Maven repository
+# Now available as: com.firecrawl:firecrawl-java:1.1.0 in local Maven repository
```
## Running Tests
diff --git a/apps/java-sdk/build.gradle.kts b/apps/java-sdk/build.gradle.kts
index 2bf8bb927..0b9524755 100644
--- a/apps/java-sdk/build.gradle.kts
+++ b/apps/java-sdk/build.gradle.kts
@@ -4,7 +4,7 @@ plugins {
}
group = "com.firecrawl"
-version = "1.0.0"
+version = "1.1.0"
java {
sourceCompatibility = JavaVersion.VERSION_11
diff --git a/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlClient.java b/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlClient.java
index efbb4724e..dcf0408ae 100644
--- a/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlClient.java
+++ b/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlClient.java
@@ -4,6 +4,8 @@ import com.firecrawl.errors.FirecrawlException;
import com.firecrawl.errors.JobTimeoutException;
import com.firecrawl.models.*;
+import okhttp3.OkHttpClient;
+
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executor;
@@ -757,6 +759,7 @@ public class FirecrawlClient {
private int maxRetries = DEFAULT_MAX_RETRIES;
private double backoffFactor = DEFAULT_BACKOFF_FACTOR;
private Executor asyncExecutor;
+ private OkHttpClient httpClient;
private Builder() {}
@@ -810,6 +813,35 @@ public class FirecrawlClient {
return this;
}
+ /**
+ * Sets a pre-configured OkHttpClient instance.
+ *
+ * <p>When provided, this client is used as-is for all HTTP requests, giving
+ * full control over connection pooling, interceptors, SSL configuration,
+ * proxy settings, timeouts, and any other OkHttp feature. The
+ * {@link #timeoutMs(long)} setting is ignored when a custom client is supplied.
+ *
+ * <p>Example:
+ * <pre>{@code
+ * OkHttpClient custom = new OkHttpClient.Builder()
+ * .proxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy.example.com", 8080)))
+ * .addInterceptor(myLoggingInterceptor)
+ * .connectTimeout(10, TimeUnit.SECONDS)
+ * .build();
+ *
+ * FirecrawlClient client = FirecrawlClient.builder()
+ * .apiKey("fc-your-api-key")
+ * .httpClient(custom)
+ * .build();
+ * }</pre>
+ *
+ * @param httpClient the OkHttpClient instance to use
+ */
+ public Builder httpClient(OkHttpClient httpClient) {
+ this.httpClient = httpClient;
+ return this;
+ }
+
public FirecrawlClient build() {
String resolvedKey = apiKey;
if (resolvedKey == null || resolvedKey.isBlank()) {
@@ -834,7 +866,7 @@ public class FirecrawlClient {
Executor executor = asyncExecutor != null ? asyncExecutor : ForkJoinPool.commonPool();
FirecrawlHttpClient http = new FirecrawlHttpClient(
- resolvedKey, resolvedUrl, timeoutMs, maxRetries, backoffFactor);
+ resolvedKey, resolvedUrl, timeoutMs, maxRetries, backoffFactor, httpClient);
return new FirecrawlClient(http, executor);
}
}
diff --git a/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlHttpClient.java b/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlHttpClient.java
index 7fbc37f0d..b89d9540a 100644
--- a/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlHttpClient.java
+++ b/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlHttpClient.java
@@ -30,16 +30,25 @@ class FirecrawlHttpClient {
final ObjectMapper objectMapper;
FirecrawlHttpClient(String apiKey, String baseUrl, long timeoutMs, int maxRetries, double backoffFactor) {
+ this(apiKey, baseUrl, timeoutMs, maxRetries, backoffFactor, null);
+ }
+
+ FirecrawlHttpClient(String apiKey, String baseUrl, long timeoutMs, int maxRetries, double backoffFactor,
+ OkHttpClient httpClient) {
this.apiKey = apiKey;
this.baseUrl = baseUrl.endsWith("/") ? baseUrl.substring(0, baseUrl.length() - 1) : baseUrl;
this.maxRetries = maxRetries;
this.backoffFactor = backoffFactor;
- this.httpClient = new OkHttpClient.Builder()
- .connectTimeout(timeoutMs, TimeUnit.MILLISECONDS)
- .readTimeout(timeoutMs, TimeUnit.MILLISECONDS)
- .writeTimeout(timeoutMs, TimeUnit.MILLISECONDS)
- .build();
+ if (httpClient != null) {
+ this.httpClient = httpClient;
+ } else {
+ this.httpClient = new OkHttpClient.Builder()
+ .connectTimeout(timeoutMs, TimeUnit.MILLISECONDS)
+ .readTimeout(timeoutMs, TimeUnit.MILLISECONDS)
+ .writeTimeout(timeoutMs, TimeUnit.MILLISECONDS)
+ .build();
+ }
this.objectMapper = new ObjectMapper()
.registerModule(new Jdk8Module())
diff --git a/apps/java-sdk/src/test/java/com/firecrawl/FirecrawlClientTest.java b/apps/java-sdk/src/test/java/com/firecrawl/FirecrawlClientTest.java
index bebed14ff..7aa4d5c74 100644
--- a/apps/java-sdk/src/test/java/com/firecrawl/FirecrawlClientTest.java
+++ b/apps/java-sdk/src/test/java/com/firecrawl/FirecrawlClientTest.java
@@ -3,10 +3,12 @@ package com.firecrawl;
import com.firecrawl.client.FirecrawlClient;
import com.firecrawl.errors.FirecrawlException;
import com.firecrawl.models.*;
+import okhttp3.OkHttpClient;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
import java.util.List;
+import java.util.concurrent.TimeUnit;
import static org.junit.jupiter.api.Assertions.*;
@@ -34,6 +36,20 @@ class FirecrawlClientTest {
assertNotNull(client);
}
+ @Test
+ void testBuilderAcceptsCustomHttpClient() {
+ OkHttpClient custom = new OkHttpClient.Builder()
+ .connectTimeout(10, TimeUnit.SECONDS)
+ .readTimeout(10, TimeUnit.SECONDS)
+ .build();
+
+ FirecrawlClient client = FirecrawlClient.builder()
+ .apiKey("fc-test-key")
+ .httpClient(custom)
+ .build();
+ assertNotNull(client);
+ }
+
@Test
void testScrapeOptionsBuilder() {
ScrapeOptions options = ScrapeOptions.builder()