Skip to content

Add agent quickstart docs for all SDK languages - #1337

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

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

What's in each file

  • Install instructions and auth pattern
  • "When to use what" guide for search vs scrape vs interact
  • Per-endpoint sections with: why to use it, preferred SDK method name, working example, and a complete parameter table confirmed from source
  • Deprecated aliases listed as migration notes (never as the preferred path)
  • Language-specific differences called out explicitly (e.g. Java/Elixir lack prompt-based interact, Elixir function names are OpenAPI-derived, Java's stop method is stopInteractiveBrowser not stopInteraction)

Files added

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

Note

These pages are not yet wired into docs.json navigation. To make them discoverable in the sidebar, add an "Agent Quickstarts" group pointing to the agent-quickstart/* paths.

Test plan

  • Verify each .mdx file renders cleanly in Mintlify
  • Spot-check parameter tables against SDK source for accuracy
  • Confirm code examples are syntactically valid in each language

Generated by Claude Code

One canonical quickstart per language (Node.js, Python, Rust, Java, Elixir)
covering search, scrape, and interact endpoints with full parameter tables.
Generated from SDK source and OpenAPI spec as the source of truth.

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

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