Skip to content

docs: add agent quickstart pages for all SDK languages - #1235

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

docs: add agent quickstart pages for all SDK languages#1235
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-8bb4v8

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add one canonical agent quickstart file per SDK language (agent-quickstart/node.mdx, python.mdx, rust.mdx, java.mdx, elixir.mdx)
  • Each file covers search, scrape, and interact endpoints with parameters verified against the latest SDK source code
  • Add navigation entries under "Build with AI > Agent Quickstarts" in docs.json

Details

Each quickstart includes:

  • Install and auth patterns
  • "When To Use What" decision guide
  • Preferred SDK method names with return types
  • Minimal working examples for each endpoint
  • Complete parameter tables with types and descriptions confirmed from source
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source-of-truth file references

SDK versions verified against source:

Language Package Version
Node.js/TypeScript firecrawl v4.32.0
Python firecrawl-py v4.34.0
Rust firecrawl (crate) v2.12.1
Java firecrawl-java v1.12.1
Elixir :firecrawl (hex) v1.9.1

Parameters cross-referenced against api-reference/v2-openapi.json and each SDK's source files. New parameters added since the existing agent-source-of-truth docs include lockdown, redactPII/redact_pii, auditMetadata/audit_metadata, includeDomains/excludeDomains, highlights, and enterprise.

Test plan

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

Generated by Claude Code

Add one canonical quickstart file per SDK language (Node.js, Python,
Rust, Java, Elixir) covering search, scrape, and interact endpoints.
Each file includes parameters verified against the latest SDK source,
practical examples, and language-specific notes. Added navigation
entries under "Build with AI > Agent Quickstarts" in docs.json.

SDK versions verified:
- JS/TS: firecrawl v4.32.0
- Python: firecrawl-py v4.34.0
- Rust: firecrawl v2.12.1
- Java: firecrawl-java v1.12.1
- Elixir: firecrawl v1.9.1

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

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