Skip to content

docs(agent-quickstart): add per-language agent quickstart guides - #1715

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds 5 new canonical agent quickstart documents in agent-quickstart/ — one per SDK language: Node.js, Python, Rust, Java, and Elixir
  • Each file covers the search, scrape, and interact endpoints with complete parameter references, realistic examples, and language-specific naming conventions
  • Generated from SDK source code and the v2 OpenAPI spec (api-reference/v2-openapi.json), with existing agent-source-of-truth/ docs used only as secondary reference

What's included per file

  • Install command and auth pattern
  • "When To Use What" decision guide
  • For each endpoint: why to use it, the exact SDK method name, a working example, and every confirmed parameter with type and short description
  • Language-specific notes (deprecated aliases, naming style differences, SDK quirks)
  • Source of truth file listing

Languages

File Package Key difference
node.mdx firecrawl camelCase params, supports both code and prompt on interact
python.mdx firecrawl-py snake_case params, prompt is keyword-only on interact
rust.mdx firecrawl crate Dedicated option structs (JsonOptions, ScreenshotOptions, etc.), supports code/prompt
java.mdx firecrawl-java Builder pattern, code-based interact only (no prompt param)
elixir.mdx firecrawl hex OpenAPI-generated verbose function names, code-based interact only

New parameters documented (vs existing source-of-truth)

These parameters were confirmed in SDK source but missing from the existing agent-source-of-truth/ docs:

  • includeDomains / excludeDomains (search)
  • country (search)
  • highlights (search, default: true)
  • domainTools / toolDetail (search + scrape)
  • enterprise / threatProtection (search)
  • lockdown (scrape)
  • checkPromptInjection (scrape)
  • redactPII (scrape)
  • auditMetadata (scrape)

Test plan

  • Verify each MDX file renders cleanly in Mintlify
  • Cross-check parameter lists against latest SDK releases
  • Confirm examples compile/run against a live Firecrawl API key

Generated by Claude Code

Add canonical quickstart documents for Node.js, Python, Rust, Java, and
Elixir covering search, scrape, and interact endpoints. Generated from
SDK source code and v2 OpenAPI spec with complete parameter references.

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

mintlify Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Oct 23, 2026, 1:11 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

This branch was successfully deployed

1 active deployment
staging — 8bc3fa84 Deployed Oct 23, 2026 by mintlify[bot]
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