Skip to content

Add agent quickstart docs for all SDK languages - #1417

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

Adds canonical agent quickstart documents for all five SDK languages in a new agent-quickstart/ directory:

  • agent-quickstart/node.mdx — Node.js/TypeScript
  • agent-quickstart/python.mdx — Python
  • agent-quickstart/rust.mdx — Rust
  • agent-quickstart/java.mdx — Java
  • agent-quickstart/elixir.mdx — Elixir

Each file covers search, scrape, and interact with:

  • What each endpoint is for and when to use it
  • Exact SDK method names and realistic examples
  • Complete parameter tables sourced from SDK code
  • Language-specific naming differences (camelCase vs snake_case)
  • Deprecated aliases noted as migration guidance, never as preferred paths
  • Response shape documentation

Source of truth

All content was generated from:

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

Notable findings

  • Java SDK: interact() requires code — does not support the prompt parameter. Documented with a note suggesting REST API fallback for prompt-based interaction.
  • Elixir SDK: Same limitation — interact_with_scrape_browser_session requires code, no prompt support. Documented with a raw Req.post workaround.
  • Elixir SDK function names: Auto-generated from OpenAPI, so they are verbose (e.g. scrape_and_extract_from_url, search_and_scrape). Documented exactly as they appear in source.

Not included

These files are not yet wired into docs.json navigation — they can be added to the nav tree in a follow-up once the content is reviewed.


🤖 Generated with Claude Code

https://claude.ai/code/session_01V8cSjbSzbdGnrWhhQ2Xg84


Generated by Claude Code

Add canonical agent quickstart documents for Node.js, Python, Rust,
Java, and Elixir in agent-quickstart/. Each file covers search, scrape,
and interact with complete parameter references sourced from SDK code
and the v2 OpenAPI spec.

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

mintlify Bot commented Sep 15, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 15, 2026, 1:19 PM

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

Copy link
Copy Markdown
Contributor Author

The "Locale literals and extraction-hostile markdown" check is failing, but this is a pre-existing issue on the base branch — not caused by this PR. All 14 findings are in locale files (es/, fr/, pt-BR/) with translated API identifiers like seguimientoDeCambios, suiviDesModifications, and rastreioDeMudan. These were introduced by the locadex translation sync in #1413 (the current HEAD of main).

This PR only adds new files in agent-quickstart/ and does not touch any locale directories.


Generated by Claude Code

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