Skip to content

Add agent quickstart docs for all SDK languages - #1275

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

Add agent quickstart docs for all SDK languages#1275
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-ofbvcu

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 from SDK source and OpenAPI spec
  • Every endpoint section includes: why to use it, the exact SDK method name, a realistic example, and a full parameter table with descriptions
  • Language-specific naming differences, deprecated aliases, and SDK quirks are documented in Notes sections

Files Added

  • agent-quickstart/node.mdx — Node.js/TypeScript (@mendable/firecrawl-js)
  • agent-quickstart/python.mdx — Python (firecrawl-py)
  • agent-quickstart/rust.mdx — Rust (firecrawl crate)
  • agent-quickstart/java.mdx — Java (com.firecrawl:firecrawl-java)
  • agent-quickstart/elixir.mdx — Elixir (:firecrawl hex package)

Source of Truth

Parameters and method signatures are confirmed from:

  1. SDK source code in firecrawl/apps/*-sdk/
  2. OpenAPI spec at api-reference/v2-openapi.json
  3. Existing docs used only as secondary reference

Notes

  • These files are not yet wired into docs.json navigation — that can be done as a follow-up once the content is reviewed
  • No localized files were modified
  • Mintlify-compatible MDX with standard frontmatter

Generated by Claude Code

One canonical 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_01VA1bTWz8x4be43M5xSHt6P
@mintlify

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