Skip to content

docs: refresh agent-source-of-truth with latest SDK parameters - #1227

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

docs: refresh agent-source-of-truth with latest SDK parameters#1227
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-ksd2xj

Conversation

@ericciarla

@ericciarla ericciarla commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updated all 6 agent-source-of-truth files (node, python, rust, java, elixir, curl) to reflect the latest SDK source code and OpenAPI spec
  • Added new parameters confirmed across all SDKs: includeDomains/excludeDomains, highlights, lockdown, redactPII (with RedactPIIOptions), auditMetadata, threatProtection, developer category
  • Added new format types: product, menu, question, highlights
  • Updated interact response to include cdpUrl field
  • Bumped documented SDK versions: JS 4.32.0, Rust 2.12.1, Java 1.12.1, Elixir 1.9.1
  • Added complex examples showing new format types (question, highlights)

Changes by file

File Key changes
node.mdx v4.32.0, added includeDomains/excludeDomains, highlights, enterprise, threatProtection, lockdown, redactPII, auditMetadata, product/menu/question/highlights formats, cdpUrl in interact response
python.mdx Same new params (snake_case), developer category, cdp_url in interact response
rust.mdx v2.12.1, include_domains/exclude_domains, highlights, lockdown, redact_pii, audit_metadata, Question/Highlights format variants
java.mdx v1.12.1, includeDomains/excludeDomains, highlights, lockdown, redactPII, auditMetadata, QuestionFormat/HighlightsFormat builder types
elixir.mdx v1.9.1, include_domains/exclude_domains, highlights, lockdown, redact_pii, audit_metadata, question/highlights format maps
curl.mdx includeDomains/excludeDomains, highlights, lockdown, redactPII with options, threatProtection, auditMetadata, question/highlights formats, cdpUrl in interact response

Source of truth

All parameters were verified against:

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

No parameters were invented — only documented what exists in source.


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.

Update all 6 agent quickstart files (node, python, rust, java, elixir,
curl) to reflect current SDK source and OpenAPI spec.

Key additions across all languages:
- Search: includeDomains/excludeDomains, highlights, developer category
- Scrape: lockdown, redactPII with RedactPIIOptions, auditMetadata,
  threatProtection, new format types (product, menu, question, highlights)
- Interact: cdpUrl in response, origin parameter
- Version bumps: JS 4.32.0, Rust 2.12.1, Java 1.12.1, Elixir 1.9.1

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

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