Skip to content

Add agent quickstart docs for all SDK languages - #1251

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart file per SDK language (Node.js, Python, Rust, Java, Elixir) in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with install, auth, examples, and complete parameter tables
  • Generated from SDK source code and the v2 OpenAPI spec, cross-referenced with existing agent-source-of-truth docs

Details

New files:

  • agent-quickstart/node.mdx — JS/TS SDK (firecrawl)
  • agent-quickstart/python.mdx — Python SDK (firecrawl-py)
  • agent-quickstart/rust.mdx — Rust SDK (firecrawl crate)
  • agent-quickstart/java.mdx — Java SDK (firecrawl-java v1.12.1)
  • agent-quickstart/elixir.mdx — Elixir SDK (firecrawl hex package)

Each quickstart includes:

  • Install command and auth pattern
  • "When To Use What" decision guide (search vs scrape vs interact)
  • One realistic example per endpoint
  • Complete parameter tables with types and descriptions confirmed from SDK source
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source of truth file references

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Confirm parameter tables match current SDK source
  • Check that examples compile/run against the latest SDK versions
  • Validate no localized files were modified

Generated by Claude Code

One canonical quickstart file per SDK language (Node.js, Python, Rust,
Java, Elixir) covering search, scrape, and interact endpoints. Each
file includes install, auth, examples, and complete parameter tables
generated from SDK source and the v2 OpenAPI spec.

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

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