diff --git a/README.md b/README.md index f68dc29107..3d2b155506 100644 --- a/README.md +++ b/README.md @@ -661,22 +661,23 @@ firecrawl agent --wait #### Agent Options -| Option | Description | -| --------------------------- | ------------------------------------------------------------- | -| `--urls ` | Comma-separated URLs to focus extraction on | -| `--model ` | `spark-1-mini` (default, cheaper) or `spark-1-pro` (accurate) | -| `--schema ` | JSON schema for structured output (inline JSON string) | -| `--schema-file ` | Path to JSON schema file for structured output | -| `--max-credits ` | Maximum credits to spend (job fails if exceeded) | -| `--webhook ` | 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 ` | Polling interval in seconds when waiting (default: 5) | -| `--timeout ` | Timeout in seconds when waiting (default: no timeout) | -| `-o, --output ` | Save output to file | -| `--json` | Output as JSON format | -| `--pretty` | Pretty print JSON output | +| Option | Description | +| --------------------------- | -------------------------------------------------------------------------------------- | +| `--urls ` | Comma-separated URLs to focus extraction on | +| `--model ` | `spark-2` (default). `spark-1-mini` and `spark-1-pro` are deprecated and run `spark-2` | +| `--effort ` | Reasoning effort: `low`, `medium`, or `high` | +| `--schema ` | JSON schema for structured output (inline JSON string) | +| `--schema-file ` | Path to JSON schema file for structured output | +| `--max-credits ` | Maximum credits to spend (job fails if exceeded) | +| `--webhook ` | 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 ` | Polling interval in seconds when waiting (default: 5) | +| `--timeout ` | Timeout in seconds when waiting (default: no timeout) | +| `-o, --output ` | Save output to file | +| `--json` | Output as JSON format | +| `--pretty` | Pretty print JSON output | #### Examples @@ -687,8 +688,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 # Save structured results to file firecrawl agent "Extract contact information" --schema-file ./contact-schema.json --wait --json -o contacts.json --pretty diff --git a/src/index.ts b/src/index.ts index 99801e2f76..6e34561577 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1583,7 +1583,7 @@ function createAgentCommand(): Command { .option('--urls ', 'Comma-separated URLs to focus extraction on') .option( '--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 ', diff --git a/src/types/agent.ts b/src/types/agent.ts index b9c6a418c0..4c876c520a 100644 --- a/src/types/agent.ts +++ b/src/types/agent.ts @@ -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;