Skip to content

docs: add agent-quickstart files for all SDK languages - #1366

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

docs: add agent-quickstart files for all SDK languages#1366
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-9qy8fn

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add canonical agent quickstart docs in agent-quickstart/ for all 5 SDK languages: Node.js, Python, Rust, Java, and Elixir
  • Each file covers search, scrape, and interact endpoints with full parameter tables, realistic examples, and language-specific notes
  • All content verified against current SDK source code and the v2 OpenAPI spec

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
  • Auth pattern
  • When-to-use-what guidance (search vs scrape vs interact)
  • For each endpoint: why to use it, preferred SDK method, working example, full parameter table with types and descriptions
  • Language-specific notes (naming conventions, deprecated aliases, quirks)
  • Source-of-truth file references

New parameters documented (not in existing agent-source-of-truth)

  • lockdown, redactPII, auditMetadata, threatProtection, includeDomains/excludeDomains, highlights, enterprise, autoResume (JS-only)

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Cross-check parameter tables against SDK source for accuracy
  • Confirm no localized files were modified

🤖 Generated with Claude Code

https://claude.ai/code/session_012bbWtGURynCkzvbQszuoiH


Generated by Claude Code

Add canonical quickstart docs for Node.js, Python, Rust, Java, and
Elixir in agent-quickstart/. Each covers search, scrape, and interact
with full parameter tables verified against current SDK source:
- 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)

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

mintlify Bot commented Sep 5, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 5, 2026, 1:18 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