Skip to content

docs(agent): mark spark-1 models deprecated in help text and README #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mogery merged 2 commits into from
Oct 1, 2026
Merged

docs(agent): mark spark-1 models deprecated in help text and README #293

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec3edd7
docs(agent): mark spark-1 models deprecated in help text and README
mogery Sep 30, 2026
75ca31b
docs: document --effort in agent options
mogery Sep 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -661,22 +661,22 @@ firecrawl agent <job-id> --wait

#### Agent Options

| Option | Description |
| --------------------------- | ------------------------------------------------------------- |
| `--urls <urls>` | Comma-separated URLs to focus extraction on |
| `--model <model>` | `spark-1-mini` (default, cheaper) or `spark-1-pro` (accurate) |
| `--schema <json>` | JSON schema for structured output (inline JSON string) |
| `--schema-file <path>` | Path to JSON schema file for structured output |
| `--max-credits <number>` | Maximum credits to spend (job fails if exceeded) |
| `--webhook <url-or-json>` | Webhook URL or configuration |
| `--status` | Check status of existing agent job |
| `--cancel` | Cancel an active agent job by job ID |
| `--wait` | Wait for agent to complete before returning results |
| `--poll-interval <seconds>` | Polling interval in seconds when waiting (default: 5) |
| `--timeout <seconds>` | Timeout in seconds when waiting (default: no timeout) |
| `-o, --output <path>` | Save output to file |
| `--json` | Output as JSON format |
| `--pretty` | Pretty print JSON output |
| Option | Description |
| --------------------------- | -------------------------------------------------------------------------------------- |
| `--urls <urls>` | Comma-separated URLs to focus extraction on |
| `--model <model>` | `spark-2` (default). `spark-1-mini` and `spark-1-pro` are deprecated and run `spark-2` |
| `--schema <json>` | JSON schema for structured output (inline JSON string) |
| `--schema-file <path>` | Path to JSON schema file for structured output |
| `--max-credits <number>` | Maximum credits to spend (job fails if exceeded) |
| `--webhook <url-or-json>` | Webhook URL or configuration |
| `--status` | Check status of existing agent job |
| `--cancel` | Cancel an active agent job by job ID |
| `--wait` | Wait for agent to complete before returning results |
| `--poll-interval <seconds>` | Polling interval in seconds when waiting (default: 5) |
| `--timeout <seconds>` | Timeout in seconds when waiting (default: no timeout) |
| `-o, --output <path>` | Save output to file |
| `--json` | Output as JSON format |
| `--pretty` | Pretty print JSON output |

#### Examples

Expand All @@ -687,8 +687,8 @@ firecrawl agent "Find the top 5 competitors of Notion and their pricing" --wait
# Extract data with cost limit
firecrawl agent "Get all blog post titles and dates" --urls https://blog.example.com --max-credits 100 --wait

# Use higher accuracy model for complex extraction
firecrawl agent "Extract detailed technical specifications" --model spark-1-pro --wait --json --pretty
# Spend more reasoning on a complex extraction
firecrawl agent "Extract detailed technical specifications" --effort high --wait --json --pretty
Comment thread
capy-ai[bot] marked this conversation as resolved.

# Save structured results to file
firecrawl agent "Extract contact information" --schema-file ./contact-schema.json --wait --json -o contacts.json --pretty
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1583,7 +1583,7 @@ function createAgentCommand(): Command {
.option('--urls <urls>', 'Comma-separated URLs to focus extraction on')
.option(
'--model <model>',
'Model to use: spark-2 (default), spark-1-mini, or spark-1-pro'
'Model to use: spark-2 (default). spark-1-mini and spark-1-pro are deprecated and run spark-2'
)
.option(
'--schema <json>',
Expand Down
2 changes: 1 addition & 1 deletion src/types/agent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export type AgentStatus = 'processing' | 'completed' | 'failed' | 'cancelled';
export interface AgentOptions {
/** Natural language prompt describing the data to extract */
prompt: string;
/** Model to use: spark-2 (default), spark-1-mini, or spark-1-pro */
/** Model to use: spark-2 (default). spark-1-mini and spark-1-pro are deprecated and run spark-2 */
model?: AgentModel;
/** Reasoning effort for the run */
effort?: AgentEffort;
Expand Down
Loading