Skip to content

docs: add agent quickstart guides for all SDK languages - #1165

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

docs: add agent quickstart guides for all SDK languages#1165
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-dne9il

Conversation

@ericciarla

@ericciarla ericciarla commented Jul 28, 2026

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 the three core endpoints: search, scrape, and interact
  • Every parameter is confirmed from the latest SDK source code and cross-referenced against the v2 OpenAPI spec
  • Includes install instructions, auth patterns, realistic examples, and language-specific notes

SDK Versions Covered

Language Package Version
Node.js firecrawl 4.31.1
Python firecrawl-py 4.33.1
Rust firecrawl (crate) 2.12.1
Java firecrawl-java 1.12.1
Elixir :firecrawl (hex) 1.9.1

What's New vs agent-source-of-truth/

These quickstart files complement the existing agent-source-of-truth/ docs and include parameters added since those were last updated:

  • includeDomains / excludeDomains on search
  • highlights on search
  • lockdown, redactPII, auditMetadata on scrape
  • enterprise on search
  • Updated format types (product, menu, question, highlights)
  • Deprecated format note (queryquestion / highlights)

Files Added

  • 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
  • Spot-check parameter lists against current SDK source
  • Confirm examples compile/run against current SDK versions

Generated by Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Add canonical agent quickstart docs for Node.js, Python, Rust, Java, and
Elixir in firecrawl-docs/agent-quickstart/. Each file covers search, scrape,
and interact endpoints with confirmed parameters, types, and examples sourced
from the latest SDK code (JS v4.31.1, Python v4.33.1, Rust v2.12.1,
Java v1.12.1, Elixir v1.9.1) and the v2 OpenAPI spec.

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

mintlify Bot commented Jul 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 Jul 28, 2026, 1:17 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