Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart document per SDK language in agent-quickstart/: Node.js, Python, Rust, Java, and Elixir.
  • Each file covers search, scrape, and interact endpoints with every confirmed parameter, short descriptions, examples, and language-specific notes.
  • Parameters and method names are sourced directly from SDK code and cross-referenced against the v2 OpenAPI spec.

Files added

File SDK version Source
agent-quickstart/node.mdx firecrawl v4.41.0 apps/js-sdk/firecrawl/src/v2/
agent-quickstart/python.mdx firecrawl-py (latest) apps/python-sdk/firecrawl/v2/
agent-quickstart/rust.mdx firecrawl crate v2.21.0 apps/rust-sdk/src/v2/
agent-quickstart/java.mdx firecrawl-java v1.18.0 apps/java-sdk/
agent-quickstart/elixir.mdx :firecrawl hex v1.11.0 apps/elixir-sdk/

What each quickstart covers

  • Install command
  • Auth/client initialization
  • When to use search vs scrape vs interact
  • For each endpoint: why use it, preferred SDK method, realistic example, full parameter table, return value notes
  • Language-specific caveats and deprecated aliases
  • Source of truth listing

Notes

  • These live in agent-quickstart/ alongside the existing agent-source-of-truth/ directory. The quickstart files are more concise and structured for easy agent consumption.
  • No localized files were modified.
  • No docs.json navigation changes included — these are standalone reference files.

🤖 Generated with Claude Code

https://claude.ai/code/session_01JP6oSmKcg4kEKAwzWrgp4Q


Generated by Claude Code

Generate one canonical agent quickstart document per SDK language
(Node.js, Python, Rust, Java, Elixir) covering search, scrape, and
interact endpoints with confirmed parameters from SDK source and
OpenAPI spec.

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

mintlify Bot commented Sep 23, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 23, 2026, 1:21 PM

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

Copy link
Copy Markdown
Contributor Author

The failing check "Locale literals and extraction-hostile markdown" is not caused by this PR. The errors are all in pre-existing locale files (es/, fr/, pt-BR/) with translated API identifiers (seguimientoDeCambios, suiviDesModifications, rastreioDeMudan, etc.) — none of which this PR touches. The same check is red on the last 5 consecutive PRs (#1461, #1460, #1459, #1458) across different authors.

No fix exists in this PR's scope since the failing files are localized content managed separately.


Generated by Claude Code

This branch was successfully deployed

1 active deployment
staging — f64e106d Deployed Sep 23, 2026 by mintlify[bot]
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