Skip to content

docs(agent-quickstart): add per-language quickstarts - #1285

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

docs(agent-quickstart): add per-language quickstarts#1285
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-fcql78

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add canonical agent quickstart files for Node.js, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with confirmed parameters, types, realistic examples, and language-specific notes
  • All content sourced from SDK source code and the v2 OpenAPI spec — no invented parameters or behavior

Details

Five new files:

  • agent-quickstart/node.mdx — firecrawl@4.34.0
  • agent-quickstart/python.mdx — firecrawl-py@4.22.1
  • agent-quickstart/rust.mdx — firecrawl crate@2.14.0
  • agent-quickstart/java.mdx — firecrawl-java@1.14.0
  • agent-quickstart/elixir.mdx — firecrawl hex@1.9.1

Each quickstart follows a consistent structure: Install → Authenticate → When To Use What → Search (with parameters table) → Scrape (with parameters table) → Interact (with parameters table) → Notes → Source Of Truth.

Language-specific differences documented:

  • Java and Elixir interact only supports code, not prompt (matching the OpenAPI spec)
  • Node.js and Python SDKs add prompt as an alternative to code for interact
  • Elixir function names are auto-generated from OpenAPI (scrape_and_extract_from_url, search_and_scrape, interact_with_scrape_browser_session)
  • Parameter naming conventions: snake_case (Python, Rust, Elixir) vs camelCase (Node.js, Java)

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Cross-check parameter lists against latest SDK source
  • Confirm examples compile/run against a live Firecrawl instance

Generated by Claude Code

…pe, and interact

Add canonical agent quickstart files for Node.js, Python, Rust, Java, and
Elixir. Each file covers search, scrape, and interact endpoints with
confirmed parameters, types, and examples sourced from the SDK code and
v2 OpenAPI spec.

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

mintlify Bot commented Aug 20, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Aug 20, 2026, 1:23 PM

💡 Tip: Enable Workflows 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