Skip to content

docs: add agent quickstart guides for all SDK languages - #1341

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

docs: add agent quickstart guides for all SDK languages#1341
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-zges5p

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds canonical per-language agent quickstart documents for Node.js/TypeScript, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with realistic examples, every confirmed parameter with descriptions, and language-specific notes
  • All content is generated from SDK source code and the OpenAPI spec (v2-openapi.json) — no invented parameters or behavior

Details

Each quickstart follows a consistent structure:

  • Install and authenticate
  • When to use what (search vs scrape vs interact)
  • Per-endpoint sections with: why use it, preferred SDK method, example, full parameter table, return type
  • Language-specific notes (naming conventions, async patterns, deprecated aliases)
  • Source of truth references

Sources used:

  • apps/js-sdk/firecrawl/src/v2/client.ts + types.ts
  • apps/python-sdk/firecrawl/v2/client.py + types.py
  • apps/rust-sdk/src/v2/scrape.rs + search.rs + types.rs
  • apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlClient.java + models
  • apps/elixir-sdk/lib/firecrawl.ex
  • api-reference/v2-openapi.json

Test plan

  • Verify each .mdx file renders cleanly in Mintlify
  • Spot-check parameter tables against SDK source for accuracy
  • Confirm examples use correct method signatures per language

Generated by Claude Code

Add canonical per-language quickstart documents covering search, scrape,
and interact endpoints for Node.js/TypeScript, Python, Rust, Java, and
Elixir. Each file is generated from SDK source code and the OpenAPI spec,
includes every confirmed parameter with descriptions, realistic examples,
and notes on language-specific naming differences and deprecated aliases.

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 31, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Aug 31, 2026, 1:28 PM

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

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