Repository navigation
Add agent quickstart docs for all SDK languages - #1743
Draft
ericciarla wants to merge 3 commits into
Draft
ericciarla wants to merge 3 commits into
ericciarla wants to merge 3 commits into
Conversation
One canonical quickstart per language (Node.js, Python, Rust, Java, Elixir) covering search, scrape, and interact endpoints. Each file includes method signatures, realistic examples, every confirmed parameter with descriptions, and deprecated alias notes. Generated from SDK source and the v2 OpenAPI spec. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01T9F5oNALdM1wYW7Jec5oo3
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
- Fix Node.js import to use named export `{ Firecrawl }` from `@mendable/firecrawl-js`
- Fix Python to use `Firecrawl` (not deprecated `FirecrawlApp`) and correct `results.web` access
- Add missing parameters across all SDKs: domainTools, toolDetail, includeDomains/excludeDomains,
country, highlights, enterprise, lockdown, checkPromptInjection, redactPII, auditMetadata,
profile, fastMode, threatProtection, autoResume
- Add new format types: product, menu, query, highlights, question
- Add stop_interaction/stopInteraction documentation to all languages
- Add "wrong turn to avoid" notes for search return type across Node and Python
- Expand Rust scrape params with json_options, screenshot_options, change_tracking_options,
attribute_selectors, audit_metadata, profile
- Update Java and Elixir with comprehensive parameter listings from latest SDK source
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T9F5oNALdM1wYW7Jec5oo3
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01T9F5oNALdM1wYW7Jec5oo3
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
agent-quickstart/search,scrape, andinteractendpoints with method signatures, realistic examples, every confirmed parameter with descriptions, and deprecated alias notesFiles added
agent-quickstart/node.mdx—@mendable/firecrawl-jsagent-quickstart/python.mdx—firecrawl-pyagent-quickstart/rust.mdx—firecrawlcrateagent-quickstart/java.mdx—com.firecrawl:firecrawl-javaagent-quickstart/elixir.mdx—firecrawlhex packageTest plan
.mdxfile renders cleanly in MintlifyGenerated by Claude Code