Skip to content

Add agent quickstart docs for all SDK languages - #1325

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add canonical agent quickstart documents for Node.js/TypeScript, Python, Rust, Java, and Elixir under agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with install instructions, auth patterns, exact SDK method names, realistic examples, and every confirmed parameter with descriptions
  • Generated from SDK source code and OpenAPI spec as source of truth — no invented parameters or behavior
  • Add "Agent Quickstarts" navigation group in the Build with AI tab of docs.json

What's in each quickstart

File Package Key methods
node.mdx @mendable/firecrawl-js scrape(), search(), interact()
python.mdx firecrawl-py scrape(), search(), interact()
rust.mdx firecrawl crate scrape(), search(), interact()
java.mdx com.firecrawl:firecrawl-java scrape(), search(), interact()
elixir.mdx :firecrawl hex scrape_and_extract_from_url(), search_and_scrape(), interact_with_scrape_browser_session()

Language-specific notes documented

  • Python and JS SDKs support prompt as an alternative to code in interact; Java and Elixir only support code
  • Elixir SDK is OpenAPI-generated with longer function names and keyword-list parameters
  • Deprecated aliases documented as migration notes in each file's Notes section
  • Parameter naming conventions documented per language (camelCase for JS/Java, snake_case for Python/Rust/Elixir)

Test plan

  • Verify each .mdx file renders cleanly in the Mintlify dev server
  • Confirm navigation shows "Agent Quickstarts" group in the Build with AI tab
  • Spot-check parameter lists against SDK source for accuracy

Generated by Claude Code

Add canonical quickstart documents for Node.js/TypeScript, Python, Rust,
Java, and Elixir covering search, scrape, and interact endpoints. Each
file includes install instructions, auth patterns, SDK method names,
realistic examples, and every confirmed parameter with descriptions.

Generated from SDK source code and OpenAPI spec as source of truth.
Navigation added under "Agent Quickstarts" group in the Build with AI tab.

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

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