Skip to content

Add agent quickstart docs for all SDK languages - #1349

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add canonical agent quickstart files for Node.js, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with method signatures, realistic examples, and complete parameter tables
  • All content generated from current SDK source code and the v2 OpenAPI spec — no invented parameters or methods
  • Navigation updated in docs.json under the "Build with AI" tab

Details

SDK versions referenced:

  • Node.js (firecrawl): v4.38.0
  • Python (firecrawl-py): v4.41.0
  • Rust (firecrawl crate): v2.18.0
  • Java (firecrawl-java): v1.17.0
  • Elixir (:firecrawl): v1.11.0

Key language-specific differences documented:

  • JS and Python SDKs support both code and prompt on interact
  • Java and Elixir SDKs support code-only interact (no prompt parameter)
  • Python search() takes a plain string for location, not a Location object
  • Elixir SDK is auto-generated from OpenAPI; function names match the spec
  • Rust uses struct-update syntax with ..Default::default() (no builder pattern)

New files

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

Modified files

  • docs.json — added "Agent Quickstarts" navigation group under "Build with AI" tab

Test plan

  • Verify all 5 quickstart pages render correctly in Mintlify
  • Verify navigation links work under "Build with AI" tab
  • Spot-check parameter tables against current SDK source
  • Confirm no localized files were modified

🤖 Generated with Claude Code

https://claude.ai/code/session_0142BEBtdpGgzuHXGCsf1RvA


Generated by Claude Code

Create canonical agent quickstart files for Node.js, Python, Rust,
Java, and Elixir covering search, scrape, and interact endpoints.
Each file is generated from current SDK source and the v2 OpenAPI spec.

SDK versions referenced:
- Node.js (firecrawl): 4.38.0
- Python (firecrawl-py): 4.41.0
- Rust (firecrawl): 2.18.0
- Java (firecrawl-java): 1.17.0
- Elixir (firecrawl): 1.11.0

Navigation updated in docs.json under Build with AI tab.

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

mintlify Bot commented Sep 2, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Sep 2, 2026, 1:21 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