Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add canonical agent quickstart docs for all 5 SDK languages (Node.js, Python, Rust, Java, Elixir) in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with complete parameters, realistic examples, and deprecated aliases
  • All content verified against current SDK source and v2 OpenAPI spec

Details

SDK versions covered:

  • JavaScript/TypeScript: @mendable/firecrawl-js 4.35.0
  • Python: firecrawl-py 4.38.0
  • Rust: firecrawl 2.16.0
  • Java: firecrawl-java 1.15.0
  • Elixir: :firecrawl 1.9.2

New parameters documented (compared to existing agent-source-of-truth files):

  • lockdown, redactPII, auditMetadata on scrape
  • includeDomains, excludeDomains, highlights, enterprise, threatProtection on search
  • product, menu, question, highlights format types
  • Updated version numbers across all SDKs

Structure per file:

  • Install → Authenticate → When To Use What → Search → Scrape → Interact → Notes → Source Of Truth
  • Mintlify-compatible MDX with valid YAML frontmatter

Test plan

  • Verify each .mdx file renders cleanly in Mintlify dev server
  • Cross-check parameter lists against SDK source for each language
  • Confirm no localized files were modified

Generated by Claude Code

Generate canonical quickstart docs for JS/TS, Python, Rust, Java, and
Elixir covering search, scrape, and interact endpoints. Each file
includes SDK method names, complete parameters, realistic examples,
and deprecated aliases — all verified against current SDK source and
the v2 OpenAPI spec.

SDK versions: JS 4.35.0, Python 4.38.0, Rust 2.16.0, Java 1.15.0,
Elixir 1.9.2.

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

mintlify Bot commented Aug 26, 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 26, 2026, 1:27 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