Skip to content

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

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

docs: add agent quickstart files for all SDK languages#1256
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-ismzye

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart document per SDK language (Node.js, Python, Rust, Java, Elixir) in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with confirmed parameters, types, defaults, and realistic examples
  • All content is generated from SDK source code and the v2 OpenAPI spec — no invented parameters or behavior

Files added

  • agent-quickstart/node.mdx — JS/TS SDK (firecrawl npm package)
  • agent-quickstart/python.mdx — Python SDK (firecrawl-py on PyPI)
  • agent-quickstart/rust.mdx — Rust SDK (firecrawl crate)
  • agent-quickstart/java.mdx — Java SDK (firecrawl-java Maven artifact)
  • agent-quickstart/elixir.mdx — Elixir SDK (firecrawl Hex package)

What each quickstart includes

  • Install command
  • Auth example
  • When-to-use-what guidance (search vs scrape vs interact)
  • Per-endpoint: why to use it, preferred SDK method, working example, full parameter table
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source of truth references

Sources used

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

Generated by Claude Code

One quickstart per 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_01N1ED7edNzHprSG9RYjZyy4
@mintlify

mintlify Bot commented Aug 13, 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 13, 2026, 1:29 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