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

Add agent quickstart docs for all SDK languages - #1650

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add 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 exact SDK method names, realistic examples, and every confirmed parameter with short descriptions
  • All content generated from SDK source code and the v2 OpenAPI spec — not copied from existing docs
  • Add "Agent Quickstarts" navigation group in docs.json, placed after "Agent Harnesses"

Details

Files added:

  • agent-quickstart/node.mdx — firecrawl v4.49.1
  • agent-quickstart/python.mdx — firecrawl-py (v2 client)
  • agent-quickstart/rust.mdx — firecrawl crate v2.21.6
  • agent-quickstart/java.mdx — firecrawl-java v1.18.5
  • agent-quickstart/elixir.mdx — :firecrawl v1.12.2

Each quickstart follows a consistent structure: Install → Authenticate → When To Use What → Search (with parameters table) → Scrape (with parameters table) → Interact (with parameters table) → Notes → Source Of Truth.

Language-specific differences are documented (e.g., Java SDK has code-only interact without prompt support, Rust SDK uses dedicated options structs for JSON/screenshot/change-tracking, Elixir SDK uses OpenAPI-generated function names).

Test plan

  • Verify each .mdx file renders correctly as a Mintlify docs page
  • Confirm navigation group appears in the sidebar under "Agent Harnesses"
  • Spot-check parameter lists against SDK source for accuracy

Generated by Claude Code

Generate one canonical quickstart document per SDK language covering
search, scrape, and interact endpoints. Each file includes the exact
SDK method names, realistic examples, and every confirmed parameter
with descriptions, all sourced from the SDK code and OpenAPI spec.

Add navigation entry in docs.json under a new "Agent Quickstarts"
group placed after "Agent Harnesses".

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

mintlify Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Copy link
Copy Markdown
Contributor Author

This branch was successfully deployed

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