Add agent quickstart docs for all SDK languages - #1423
Draft
ericciarla wants to merge 1 commit into
Draft
ericciarla wants to merge 1 commit into
ericciarla wants to merge 1 commit into
Conversation
Add canonical agent quickstart documents for Node.js, Python, Rust, Java, and Elixir covering search, scrape, and interact endpoints. Each file includes every confirmed parameter with descriptions, realistic examples, and language-specific naming conventions. Generated from latest SDK source (JS v4.40.0, Python firecrawl-py, Rust v2.20.0, Java v1.18.0, Elixir v1.11.0) and v2 OpenAPI spec. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QepdZCK4K1VT7RWYfzX1Rf
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
Author
|
CI note: The "Locale literals and extraction-hostile markdown" check is failing on pre-existing translated API identifiers in Generated by Claude Code |
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
2 participants
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\n\nAdds canonical agent quickstart documents for all five SDK languages in a new
agent-quickstart/directory:\n\n-agent-quickstart/node.mdx— Node.js/TypeScript (SDK v4.40.0)\n-agent-quickstart/python.mdx— Python (firecrawl-py)\n-agent-quickstart/rust.mdx— Rust (crate v2.20.0)\n-agent-quickstart/java.mdx— Java (v1.18.0)\n-agent-quickstart/elixir.mdx— Elixir (v1.11.0)\n\nEach file covers thesearch,scrape, andinteractendpoints with:\n- Install and auth instructions\n- When-to-use-what decision guide\n- Realistic code examples\n- Every confirmed parameter with short descriptions\n- Language-specific naming conventions and caveats\n- Deprecated alias migration notes\n- Source-of-truth file references\n\n## Motivation\n\nThese quickstart files are designed to be pasted directly into agent context windows. They serve as the canonical, SDK-source-verified reference for external agents integrating with Firecrawl, complementing the existingagent-source-of-truth/reference docs.\n\n## Source verification\n\nAll content was generated from:\n1. SDK source code infirecrawl/apps/{js,python,rust,java,elixir}-sdk/\n2. OpenAPI spec atapi-reference/v2-openapi.json\n3. Existing docs used only as secondary reference\n\nNo parameters were invented — only SDK-confirmed surface is documented.\n\n---\n\n🤖 Generated with Claude Code\n\nhttps://claude.ai/code/session_01QepdZCK4K1VT7RWYfzX1RfGenerated by Claude Code