Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds canonical agent quickstart docs for Node.js, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers search, scrape, and interact with every confirmed SDK parameter, short descriptions, and realistic examples
  • Generated from SDK source code and the OpenAPI spec (v2-openapi.json), not from existing docs
  • Adds an "Agent Quickstarts" navigation group to the "Build with AI" tab in docs.json

What each file includes

  • Install command and auth pattern
  • "When to use what" decision guide (search vs scrape vs interact)
  • For each endpoint: why to use it, preferred SDK method name, working example, and a full parameter table
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source of truth references

Language-specific highlights

  • Node.js / Python / Rust: Document both code and prompt for interact
  • Java / Elixir: Document that interact only supports code (no prompt)
  • Elixir: Uses OpenAPI-generated function names (search_and_scrape, scrape_and_extract_from_url, interact_with_scrape_browser_session)
  • Rust: Documents struct literal construction with ..Default::default()
  • Java: Documents builder pattern and CompletableFuture async variants

Test plan

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

Generated by Claude Code

… Elixir

Canonical one-file-per-language quickstarts for external agents, covering
search, scrape, and interact endpoints with every confirmed SDK parameter.
Generated from SDK source and the OpenAPI spec.

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

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