Skip to content

Add agent quickstart docs for all SDK languages - #1350

Draft
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-qzjftw
Draft

Add agent quickstart docs for all SDK languages#1350
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-qzjftw

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds canonical agent quickstart files for Node.js, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with install instructions, auth patterns, realistic examples, and exhaustive parameter tables
  • All content generated from the latest SDK source code and the v2 OpenAPI spec — not from existing docs
  • Adds "Agent Quickstarts" navigation group to docs.json under the Build with AI tab

SDK versions covered

Language Package Version
Node.js firecrawl v4.38.0
Python firecrawl-py v4.22.1
Rust firecrawl (crate) v2.18.0
Java firecrawl-java v1.17.0
Elixir :firecrawl v1.11.0

What each quickstart includes

  • Install command
  • Authentication pattern
  • When to use search vs scrape vs interact
  • For each endpoint: why to use it, preferred SDK method, working example, every confirmed parameter with type and description
  • Language-specific notes (deprecated aliases, naming conventions, SDK quirks)
  • Source of truth file list

Notable language differences documented

  • Node.js, Python, Rust: interact supports both code and prompt (natural-language browser control)
  • Java, Elixir: interact supports code only (no prompt parameter)
  • Python accepts both camelCase and snake_case format strings
  • Elixir uses atoms for proxy values (:basic, :enhanced, :auto)

🤖 Generated with Claude Code

https://claude.ai/code/session_01Dfgvg6Khaj6ASeD1M5WEVj


Generated by Claude Code

Create canonical agent quickstart files for Node.js, Python, Rust,
Java, and Elixir covering search, scrape, and interact endpoints.
Each file includes install, auth, examples, and exhaustive parameter
tables generated from the latest SDK source code.

- Node.js: firecrawl v4.38.0
- Python: firecrawl-py v4.22.1
- Rust: firecrawl crate v2.18.0
- Java: firecrawl-java v1.17.0
- Elixir: firecrawl v1.11.0

Also adds Agent Quickstarts navigation group to docs.json under
the Build with AI tab.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Dfgvg6Khaj6ASeD1M5WEVj
@mintlify

mintlify Bot commented Sep 3, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Sep 3, 2026, 1:17 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants