Skip to content

Add agent quickstart docs for all five SDK languages - #1403

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds canonical agent quickstart documents for Node.js, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with install instructions, auth patterns, SDK method names, realistic examples, and every confirmed parameter with descriptions
  • Generated from SDK source code and the OpenAPI spec as the source of truth — no parameters or methods were invented

Files

File SDK Source SDK Version
agent-quickstart/node.mdx @mendable/firecrawl-js 4.39.0
agent-quickstart/python.mdx firecrawl-py latest
agent-quickstart/rust.mdx firecrawl crate 2.19.0
agent-quickstart/java.mdx firecrawl-java 1.18.0
agent-quickstart/elixir.mdx :firecrawl 1.11.0

Structure per file

Each quickstart follows an identical structure:

  1. Install command
  2. Auth / initialization pattern
  3. When To Use What (search vs scrape vs interact)
  4. Search — why, method name, example, full parameter table
  5. Scrape — why, method name, example, full parameter table
  6. Interact — why, method name, example, full parameter table
  7. Language-specific notes (naming conventions, deprecated aliases, quirks)
  8. Source of truth references

Test plan

  • Verify each .mdx file renders cleanly in Mintlify
  • Spot-check parameter tables against SDK source
  • Confirm examples use preferred (non-deprecated) method names

🤖 Generated with Claude Code

https://claude.ai/code/session_01Q1Z6pcygGy33PrRH2VqWLn


Generated by Claude Code

Create canonical quickstart documents for Node.js, Python, Rust, Java,
and Elixir covering search, scrape, and interact endpoints. Each file
includes install instructions, auth patterns, SDK method names, realistic
examples, and every confirmed parameter with descriptions. Generated from
SDK source and OpenAPI spec as the source of truth.

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

mintlify Bot commented Sep 11, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 11, 2026, 1:16 PM

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

Copy link
Copy Markdown
Contributor Author

CI status note: The "Locale literals and extraction-hostile markdown" check is failing, but this is a pre-existing issue on the base branch — all recent PRs (including locadex translation PRs and unrelated docs PRs) show the same failure. The errors are in localized files (es/, fr/, pt-BR/) with translated API identifiers like seguimientoDeCambios, suiviDesModifications, and rastreioDeMudan. None of these files are touched by this PR.

The two Mintlify checks (Deployment and Validation) are still in progress.


Generated by Claude Code

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