Skip to content

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

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

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

Conversation

@ericciarla

@ericciarla ericciarla commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds canonical agent quickstart documents for Node.js, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers the three core endpoints: search, scrape, and interact
  • Every endpoint section includes the preferred SDK method name, a realistic example, and a complete parameter table with descriptions — all confirmed from SDK source code and the OpenAPI spec
  • Language-specific notes document naming conventions (camelCase vs snake_case), deprecated aliases, and SDK quirks

Details

These quickstart files are designed to be pasted directly into external agent context windows. They are:

  • Source-accurate: Generated from SDK source (@mendable/firecrawl-js v4, firecrawl-py v4, firecrawl crate v2, firecrawl-java v1.12, firecrawl hex v1.9) cross-referenced with api-reference/v2-openapi.json
  • Complete: Every confirmed parameter is documented with type, description, and server defaults where known
  • Practical: Minimal working examples for each endpoint, not abstract API descriptions
  • Honest: No invented parameters or undocumented behavior — gaps are omitted rather than guessed

Key finding documented: the interact endpoint now uses a code/prompt execution model (not the old actions-based pattern, which is part of scrape via the actions parameter).

Files added

File Language Lines
agent-quickstart/node.mdx JavaScript/TypeScript ~250
agent-quickstart/python.mdx Python ~230
agent-quickstart/rust.mdx Rust ~240
agent-quickstart/java.mdx Java ~240
agent-quickstart/elixir.mdx Elixir ~225

Note

The agent-quickstart directory is not yet added to the docs.json navigation. It should be added under the appropriate tab/group when ready to publish.


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.

Add canonical quickstart documents for Node.js, Python, Rust, Java, and
Elixir covering search, scrape, and interact endpoints. Each file includes
method signatures, all confirmed parameters with descriptions, realistic
examples, and language-specific notes. Generated from SDK source code and
the Firecrawl OpenAPI spec.

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

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