Add agent quickstart docs for all SDK languages by ericciarla · Pull Request #1692 · firecrawl/firecrawl-docs · GitHub
Skip to content

Add agent quickstart docs for all SDK languages - #1692

Draft
ericciarla wants to merge 6 commits into
mainfrom
claude/eager-dijkstra-qw8j79
Draft

ericciarla wants to merge 6 commits into
mainfrom
claude/eager-dijkstra-qw8j79

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Create agent-quickstart/ directory with one canonical quickstart file per SDK language: Node.js, Python, Rust, Java, and Elixir
  • Each file covers search, scrape, and interact endpoints with verified parameter lists, realistic examples, and language-specific notes
  • Generated from the latest SDK source code and v2 OpenAPI spec — not from existing docs

What's in each file

  • Install and auth instructions
  • "When To Use What" decision guide
  • For each endpoint: why to use it, the preferred SDK method, a working example, and a complete parameter table
  • Language-specific notes (deprecated aliases, naming conventions, SDK quirks)
  • Source of truth references

SDK versions verified

Language Package Version
Node.js firecrawl 4.50.0
Python firecrawl-py latest (dynamic)
Rust firecrawl 2.21.8
Java firecrawl-java 1.18.7
Elixir :firecrawl 1.12.4

Test plan

  • Verify each .mdx file renders cleanly in Mintlify
  • Spot-check parameter tables against SDK source
  • Confirm examples compile/run with current SDK versions

Generated by Claude Code

Create canonical agent quickstart files in agent-quickstart/ covering
search, scrape, and interact for Node.js, Python, Rust, Java, and
Elixir. Each file is generated from the latest SDK source code and
the v2 OpenAPI spec, with verified parameter lists, examples, and
language-specific notes.

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

mintlify Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Oct 21, 2026, 1:16 PM

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

- Node.js: bump version 4.18.2 → 4.50.0, add missing search params
  (includeDomains, excludeDomains, country, highlights, domainTools,
  toolDetail, enterprise, threatProtection), add missing scrape params
  (lockdown, checkPromptInjection, redactPII, threatProtection,
  auditMetadata, domainTools, toolDetail), add product/menu/query
  formats, add image parser
- Python: remove hardcoded version (dynamic), add tools to SearchData

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CK48ru2oBcHjbDw7fuN2EF
- Bump version 1.18.5 → 1.18.7
- Add missing search params: includeDomains, excludeDomains, country,
  highlights
- Add missing scrape params: lockdown, checkPromptInjection, redactPII,
  auditMetadata

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CK48ru2oBcHjbDw7fuN2EF
- Bump install version ~> 1.0.0 → ~> 1.12
- Add missing search params: include_domains, exclude_domains,
  highlights, domain_tools, tool_detail, threat_protection

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CK48ru2oBcHjbDw7fuN2EF
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CK48ru2oBcHjbDw7fuN2EF
- Add 6 missing search params: include_domains, exclude_domains,
  country, highlights, domain_tools, tool_detail
- Update formats to include Product, Menu, Question, Highlights, Query
- Add 6 missing scrape params: lockdown, check_prompt_injection,
  redact_pii, audit_metadata, domain_tools, tool_detail

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

This branch was successfully deployed

1 active deployment
staging — a7f18fdf Deployed Oct 21, 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