Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add canonical agent quickstart docs in agent-quickstart/ for Node.js, Python, Rust, Java, and Elixir
  • Each file covers search, scrape, and interact with every confirmed parameter from SDK source and OpenAPI spec
  • Uses table-based parameter documentation for easier agent consumption

What changed

Generated from the latest SDK source code (not existing docs):

  • Node.js (firecrawl v4.35.0): includes includeDomains/excludeDomains, highlights, lockdown, redactPII, developer category
  • Python (firecrawl-py v4.38.0): includes include_domains/exclude_domains, highlights, lockdown, threat_protection
  • Rust (firecrawl crate v2.16.0): includes lockdown, redact_pii, include_domains/exclude_domains, highlights
  • Java (firecrawl-java v1.15.0): includes lockdown, redactPII, includeDomains/excludeDomains, highlights
  • Elixir (:firecrawl v1.9.2): includes lockdown, redact_pii, include_domains/exclude_domains, highlights, enterprise

Source of truth

All parameters verified against:

  1. SDK source files in firecrawl/apps/*-sdk/
  2. OpenAPI spec at api-reference/v2-openapi.json

No parameters were invented — only documented what the SDK public surface confirms.

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Spot-check parameter lists against SDK source
  • Confirm no localized files were modified

Generated by Claude Code

Generate canonical quickstart docs for Node.js, Python, Rust, Java,
and Elixir in agent-quickstart/. Each covers search, scrape, and
interact with verified parameters from SDK source and OpenAPI spec.

Key updates from current agent-source-of-truth files:
- JS SDK version 4.35.0, Python 4.38.0, Rust 2.16.0, Java 1.15.0, Elixir 1.9.2
- New params: lockdown, redactPII, includeDomains/excludeDomains, highlights
- Search categories now include "developer"
- Table-based parameter docs for easier scanning

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

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