Skip to content

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

feat(sdk): add model parameter to agent endpoint (#2663)

firecrawl-spring[bot]58f2fd5929c8
diff --git a/apps/js-sdk/firecrawl/package.json b/apps/js-sdk/firecrawl/package.json
index 33d81a7a6..55145d200 100644
--- a/apps/js-sdk/firecrawl/package.json
+++ b/apps/js-sdk/firecrawl/package.json
@@ -1,6 +1,6 @@
{
"name": "@mendable/firecrawl-js",
- "version": "4.10.0",
+ "version": "4.11.0",
"description": "JavaScript SDK for Firecrawl API",
"main": "dist/index.js",
"types": "dist/index.d.ts",
diff --git a/apps/js-sdk/firecrawl/src/v2/methods/agent.ts b/apps/js-sdk/firecrawl/src/v2/methods/agent.ts
index 815a8ea65..af6cd4fca 100644
--- a/apps/js-sdk/firecrawl/src/v2/methods/agent.ts
+++ b/apps/js-sdk/firecrawl/src/v2/methods/agent.ts
@@ -11,6 +11,7 @@ function prepareAgentPayload(args: {
integration?: string;
maxCredits?: number;
strictConstrainToURLs?: boolean;
+ model?: "spark-1-pro" | "spark-1-mini";
}): Record<string, unknown> {
const body: Record<string, unknown> = {};
if (args.urls) body.urls = args.urls;
@@ -23,6 +24,7 @@ function prepareAgentPayload(args: {
if (args.integration && args.integration.trim()) body.integration = args.integration.trim();
if (args.maxCredits !== null && args.maxCredits !== undefined) body.maxCredits = args.maxCredits;
if (args.strictConstrainToURLs !== null && args.strictConstrainToURLs !== undefined) body.strictConstrainToURLs = args.strictConstrainToURLs;
+ if (args.model !== null && args.model !== undefined) body.model = args.model;
return body;
}
diff --git a/apps/python-sdk/firecrawl/__init__.py b/apps/python-sdk/firecrawl/__init__.py
index 18123cf7b..7caa86891 100644
--- a/apps/python-sdk/firecrawl/__init__.py
+++ b/apps/python-sdk/firecrawl/__init__.py
@@ -17,7 +17,7 @@ from .v1 import (
V1ChangeTrackingOptions,
)
-__version__ = "4.12.0"
+__version__ = "4.13.0"
# Define the logger for the Firecrawl project
logger: logging.Logger = logging.getLogger("firecrawl")
diff --git a/apps/python-sdk/firecrawl/v2/client.py b/apps/python-sdk/firecrawl/v2/client.py
index 7b8c35b30..338a61b32 100644
--- a/apps/python-sdk/firecrawl/v2/client.py
+++ b/apps/python-sdk/firecrawl/v2/client.py
@@ -764,6 +764,7 @@ class FirecrawlClient:
integration: Optional[str] = None,
max_credits: Optional[int] = None,
strict_constrain_to_urls: Optional[bool] = None,
+ model: Optional[Literal["spark-1-pro", "spark-1-mini"]] = None,
):
"""Start an agent job (non-blocking).
@@ -773,6 +774,7 @@ class FirecrawlClient:
schema: Target JSON schema for the output (dict or Pydantic BaseModel)
integration: Integration tag/name
max_credits: Maximum credits to use (optional)
+ model: Model to use for the agent ("spark-1-pro" or "spark-1-mini")
Returns:
Response payload with job id/status (poll with get_agent_status)
"""
@@ -784,6 +786,7 @@ class FirecrawlClient:
integration=integration,
max_credits=max_credits,
strict_constrain_to_urls=strict_constrain_to_urls,
+ model=model,
)
def agent(
@@ -797,6 +800,7 @@ class FirecrawlClient:
timeout: Optional[int] = None,
max_credits: Optional[int] = None,
strict_constrain_to_urls: Optional[bool] = None,
+ model: Optional[Literal["spark-1-pro", "spark-1-mini"]] = None,
):
"""Run an agent and wait until completion.
@@ -808,6 +812,7 @@ class FirecrawlClient:
poll_interval: Seconds between status checks
timeout: Maximum seconds to wait (None for no timeout)
max_credits: Maximum credits to use (optional)
+ model: Model to use for the agent ("spark-1-pro" or "spark-1-mini")
Returns:
Final agent response when completed
"""
@@ -821,6 +826,7 @@ class FirecrawlClient:
timeout=timeout,
max_credits=max_credits,
strict_constrain_to_urls=strict_constrain_to_urls,
+ model=model,
)
def get_agent_status(self, job_id: str):
diff --git a/apps/python-sdk/firecrawl/v2/methods/agent.py b/apps/python-sdk/firecrawl/v2/methods/agent.py
index e168fb1ba..a83250c3d 100644
--- a/apps/python-sdk/firecrawl/v2/methods/agent.py
+++ b/apps/python-sdk/firecrawl/v2/methods/agent.py
@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Literal, Optional
import time
from ..types import AgentResponse
@@ -15,6 +15,7 @@ def _prepare_agent_request(
integration: Optional[str] = None,
max_credits: Optional[int] = None,
strict_constrain_to_urls: Optional[bool] = None,
+ model: Optional[Literal["spark-1-pro", "spark-1-mini"]] = None,
) -> Dict[str, Any]:
body: Dict[str, Any] = {}
if urls is not None:
@@ -35,6 +36,8 @@ def _prepare_agent_request(
body["maxCredits"] = max_credits
if strict_constrain_to_urls is not None and strict_constrain_to_urls:
body["strictConstrainToURLs"] = strict_constrain_to_urls
+ if model is not None:
+ body["model"] = model
return body
@@ -56,6 +59,7 @@ def start_agent(
integration: Optional[str] = None,
max_credits: Optional[int] = None,
strict_constrain_to_urls: Optional[bool] = None,
+ model: Optional[Literal["spark-1-pro", "spark-1-mini"]] = None,
) -> AgentResponse:
body = _prepare_agent_request(
urls,
@@ -64,6 +68,7 @@ def start_agent(
integration=integration,
max_credits=max_credits,
strict_constrain_to_urls=strict_constrain_to_urls,
+ model=model,
)
resp = client.post("/v2/agent", body)
if not resp.ok:
@@ -108,6 +113,7 @@ def agent(
timeout: Optional[int] = None,
max_credits: Optional[int] = None,
strict_constrain_to_urls: Optional[bool] = None,
+ model: Optional[Literal["spark-1-pro", "spark-1-mini"]] = None,
) -> AgentResponse:
started = start_agent(
client,
@@ -117,6 +123,7 @@ def agent(
integration=integration,
max_credits=max_credits,
strict_constrain_to_urls=strict_constrain_to_urls,
+ model=model,
)
job_id = getattr(started, "id", None)
if not job_id:
diff --git a/apps/python-sdk/firecrawl/v2/methods/aio/agent.py b/apps/python-sdk/firecrawl/v2/methods/aio/agent.py
index 09fb7f626..87940242f 100644
--- a/apps/python-sdk/firecrawl/v2/methods/aio/agent.py
+++ b/apps/python-sdk/firecrawl/v2/methods/aio/agent.py
@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Literal, Optional
import asyncio
from ...types import AgentResponse
@@ -14,6 +14,7 @@ def _prepare_agent_request(
integration: Optional[str] = None,
max_credits: Optional[int] = None,
strict_constrain_to_urls: Optional[bool] = None,
+ model: Optional[Literal["spark-1-pro", "spark-1-mini"]] = None,
) -> Dict[str, Any]:
body: Dict[str, Any] = {}
if urls is not None:
@@ -34,6 +35,8 @@ def _prepare_agent_request(
body["maxCredits"] = max_credits
if strict_constrain_to_urls is not None and strict_constrain_to_urls:
body["strictConstrainToURLs"] = strict_constrain_to_urls
+ if model is not None:
+ body["model"] = model
return body
@@ -55,6 +58,7 @@ async def start_agent(
integration: Optional[str] = None,
max_credits: Optional[int] = None,
strict_constrain_to_urls: Optional[bool] = None,
+ model: Optional[Literal["spark-1-pro", "spark-1-mini"]] = None,
) -> AgentResponse:
body = _prepare_agent_request(
urls,
@@ -63,6 +67,7 @@ async def start_agent(
integration=integration,
max_credits=max_credits,
strict_constrain_to_urls=strict_constrain_to_urls,
+ model=model,
)
resp = await client.post("/v2/agent", body)
payload = _normalize_agent_response_payload(resp.json())
@@ -103,6 +108,7 @@ async def agent(
timeout: Optional[int] = None,
max_credits: Optional[int] = None,
strict_constrain_to_urls: Optional[bool] = None,
+ model: Optional[Literal["spark-1-pro", "spark-1-mini"]] = None,
) -> AgentResponse:
started = await start_agent(
client,
@@ -112,6 +118,7 @@ async def agent(
integration=integration,
max_credits=max_credits,
strict_constrain_to_urls=strict_constrain_to_urls,
+ model=model,
)
job_id = getattr(started, "id", None)
if not job_id: