Skip to content

Add agent quickstart docs for all SDK languages - #1467

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add one canonical agent quickstart file 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 from SDK source and the v2 OpenAPI spec
  • Includes install instructions, auth patterns, realistic examples, parameter tables with descriptions, and language-specific notes

SDK versions documented

Language Package Version
Node.js firecrawl 4.41.0
Python firecrawl-py latest (dynamic versioning)
Rust firecrawl (crate) 2.21.0
Java firecrawl-java 1.18.0
Elixir firecrawl (hex) 1.11.0

Source of truth

Parameters and method signatures were extracted from SDK source code (primary) and cross-referenced against the v2 OpenAPI spec at api-reference/v2-openapi.json (secondary). No parameters were inferred across languages — each file documents only what that SDK's source confirms.

New files

  • agent-quickstart/node.mdx
  • agent-quickstart/python.mdx
  • agent-quickstart/rust.mdx
  • agent-quickstart/java.mdx
  • agent-quickstart/elixir.mdx

Notes

  • These files are Mintlify-compatible MDX with valid YAML frontmatter
  • The agent-quickstart/ directory is not yet added to docs.json navigation — add it when ready to publish
  • Java and Elixir SDKs only support code-based interact (no prompt parameter), which is documented explicitly
  • No localized files were created or modified

🤖 Generated with Claude Code

https://claude.ai/code/session_01CRE4N71u5hkWNSkwD7Wuxt


Generated by Claude Code

Add one canonical quickstart per SDK language (Node.js, Python, Rust,
Java, Elixir) in agent-quickstart/. Each file covers search, scrape, and
interact endpoints with confirmed parameters from SDK source and the v2
OpenAPI spec.

SDK versions documented:
- Node.js (firecrawl v4.41.0)
- Python (firecrawl-py)
- Rust (firecrawl v2.21.0)
- Java (firecrawl-java v1.18.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_01CRE4N71u5hkWNSkwD7Wuxt
@mintlify

mintlify Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 25, 2026, 1:20 PM

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

Copy link
Copy Markdown
Contributor Author

CI status: The "Locale literals and extraction-hostile markdown" check is red, but this is a pre-existing failure on the base branch — the same check fails identically on every recent PR (#1465, #1466). All flagged files are in locale directories (es/, fr/, pt-BR/), none in agent-quickstart/. This PR only adds new English-language base files.

The "Mintlify Deployment" and "Mintlify Validation - link-rot" checks are still in progress.


Generated by Claude Code

This branch was successfully deployed

1 active deployment
staging — 83e3c5b7 Deployed Sep 25, 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