Skip to content

Add agent quickstart docs for all SDK languages - #1333

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical quickstart document per SDK language in agent-quickstart/: Node.js, Python, Rust, Java, and Elixir
  • Each file covers search, scrape, and interact with full parameter documentation, examples, and language-specific notes
  • Generated from SDK source code and the OpenAPI spec (v2-openapi.json) as the sources of truth

Details

Each quickstart follows a consistent structure:

  • Install command
  • Authentication pattern (including keyless free tier)
  • When to use each endpoint
  • Per-endpoint sections with: why to use it, preferred SDK method name, working example, complete parameter table, and response description
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source of truth listing

Key cross-language differences documented:

  • Java and Elixir interact require code; JS, Python, and Rust also support prompt for natural-language browser agent instructions
  • Elixir uses OpenAPI-shaped function names (search_and_scrape, scrape_and_extract_from_url, interact_with_scrape_browser_session)
  • Python uses snake_case parameters; JS/Java use camelCase; Rust uses snake_case structs with serde camelCase serialization

New files

  • agent-quickstart/node.mdx
  • agent-quickstart/python.mdx
  • agent-quickstart/rust.mdx
  • agent-quickstart/java.mdx
  • agent-quickstart/elixir.mdx

Test plan

  • Verify each MDX file renders correctly in Mintlify
  • Confirm parameter tables match current SDK source
  • Check code examples compile/run against latest SDK versions

Generated by Claude Code

One-file-per-language canonical quickstart covering search, scrape,
and interact for Node.js, Python, Rust, Java, and Elixir. Generated
from SDK source and OpenAPI spec with full parameter documentation.

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

mintlify Bot commented Aug 28, 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 28, 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