Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add one canonical quickstart document per SDK language in agent-quickstart/: Node.js, Python, Rust, Java, and Elixir.
  • Each file covers search, scrape, and interact endpoints with confirmed parameters from SDK source code and the v2 OpenAPI spec.
  • Designed to be easy to paste into agent context — practical examples, complete parameter tables, no marketing language.

Details

Files added:

  • agent-quickstart/node.mdx — JS/TS SDK v4.42.4
  • agent-quickstart/python.mdx — Python SDK v4.46.2
  • agent-quickstart/rust.mdx — Rust SDK v2.21.2
  • agent-quickstart/java.mdx — Java SDK v1.18.2
  • agent-quickstart/elixir.mdx — Elixir SDK v1.11.3

Each quickstart includes:

  • Install command and auth pattern
  • When to use search vs scrape vs interact
  • SDK method names with realistic examples
  • Every confirmed parameter with short descriptions
  • Language-specific naming differences (camelCase/snake_case)
  • Deprecated aliases as migration notes
  • Source of truth file list

Sources used (priority order):

  1. SDK source code in firecrawl/apps/*-sdk/
  2. OpenAPI spec at firecrawl-docs/api-reference/v2-openapi.json
  3. Existing agent-source-of-truth/ docs as secondary reference

No localized files were modified.

🤖 Generated with Claude Code

https://claude.ai/code/session_01DLhcgBKAcw9u4o98a1T6J4


Generated by Claude Code

Add one canonical quickstart document per SDK language (Node.js, Python,
Rust, Java, Elixir) in agent-quickstart/. Each covers search, scrape, and
interact with confirmed parameters from SDK source and OpenAPI spec.

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

mintlify Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Oct 3, 2026, 1:20 PM

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

Copy link
Copy Markdown
Contributor Author

CI failure — not caused by this PR.

The failing check "Locale literals and extraction-hostile markdown" reports translated API literals in es/, fr/, and pt-BR/ locale files (e.g. seguimientoDeCambios, suiviDesModifications, rastreioDeMudan). This PR only adds new files in agent-quickstart/ and does not touch any localized files.

The same check is failing on other recent PRs (runs #215, #216, #217) with identical errors, confirming this is a pre-existing issue in the locale files. No fix PR exists for the locale literals at this time, and per repo guidelines localized files should not be modified in content PRs.


Generated by Claude Code

This branch was successfully deployed

1 active deployment
staging — 519eeae9 Deployed Oct 3, 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