Skip to content

docs: add agent quickstart guides for all SDK languages - #1311

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

docs: add agent quickstart guides for all SDK languages#1311
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-1cetfy

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add canonical agent quickstart docs for Node.js, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with complete parameter tables
  • Generated from SDK source code and the v2 OpenAPI spec — not from existing docs
  • Every parameter is confirmed from source; no invented methods, defaults, or behavior

What's in each quickstart

  • Install command
  • Auth pattern
  • "When To Use What" decision guide
  • For each of search/scrape/interact: why to use it, preferred SDK method, realistic example, full parameter table with types and descriptions
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source of truth file listing

SDK versions covered

Language Package Version
Node.js firecrawl 4.35.0
Python firecrawl-py latest v2
Rust firecrawl 2.16.0
Java firecrawl-java 1.15.0
Elixir :firecrawl 1.9.2

Language-specific differences documented

  • Java SDK: interact supports code only (no prompt parameter)
  • Elixir SDK: interact supports code only (no prompt parameter); function names are OpenAPI-generated
  • Python SDK: snake_case params, prompt is keyword-only on interact
  • Rust SDK: dedicated options structs for JSON, screenshot, change tracking formats

Test plan

  • Verify each .mdx file renders cleanly in Mintlify
  • Cross-check parameter lists against latest SDK releases
  • Confirm no localized files were modified

Generated by Claude Code

Add canonical agent quickstart docs for Node.js, Python, Rust, Java,
and Elixir covering search, scrape, and interact endpoints. Each file
is generated from SDK source and the v2 OpenAPI spec with complete
parameter documentation.

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

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