Skip to content

docs(agent-quickstart): add canonical agent quickstarts for all SDK languages - #1482

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds 5 new agent quickstart docs under agent-quickstart/ — one per SDK language: Node/TypeScript, Python, Rust, Java, Elixir
  • Each file covers the search, scrape, and interact endpoints with:
    • Install/auth instructions
    • "When To Use What" decision guide
    • Preferred SDK method names
    • Realistic working examples
    • Complete parameter tables with types, descriptions, and confirmed defaults
    • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
    • Source of truth references

Source of truth

All content generated from:

  1. SDK source code in firecrawl/apps/*-sdk/ (primary)
  2. OpenAPI spec at api-reference/v2-openapi.json (secondary)
  3. Existing docs only as layout/style reference

Language-specific highlights

  • Node: camelCase params, SearchData has no .data property, autoResume SDK-only option
  • Python: snake_case params, async client available (AsyncFirecrawl), Pydantic models accept both cases
  • Rust: snake_case fields serialized to camelCase, SearchResponse wraps data in .data field
  • Java: interact() takes code as required positional param (no separate prompt param), builder pattern for options
  • Elixir: auto-generated from OpenAPI, verbose function names, NimbleOptions runtime validation, bang variants

Files changed

File Description
agent-quickstart/node.mdx Node/TypeScript agent quickstart
agent-quickstart/python.mdx Python agent quickstart
agent-quickstart/rust.mdx Rust agent quickstart
agent-quickstart/java.mdx Java agent quickstart
agent-quickstart/elixir.mdx Elixir agent quickstart

Notes

  • These files are not yet wired into the docs navigation (docs.json). That can be added in a follow-up or as part of review.
  • No localized files were modified.
  • All MDX uses standard Mintlify-compatible formatting (YAML frontmatter, fenced code blocks, Markdown tables, <Tabs> component only where already used in docs).

🤖 Generated with Claude Code

https://claude.ai/code/session_011Cikwut5wXoShdc1AerRq4


Generated by Claude Code

…anguages

Add one-file-per-language agent quickstart docs covering search, scrape,
and interact endpoints with full parameter tables, realistic examples,
and language-specific notes. Each file is generated from SDK source code
and the OpenAPI spec as the source of truth.

Languages: Node/TypeScript, Python, Rust, Java, Elixir.

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

mintlify Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

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

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

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

Copy link
Copy Markdown
Contributor Author

The failing CI check ("Locale literals and extraction-hostile markdown") is a pre-existing failure on the base branch — not caused by this PR. All reported errors are in localized translation files (es/, fr/, pt-BR/) with translated API identifiers like seguimientoDeCambios, suiviDesModifications, and rastreioDeMudan. This PR only adds new files under agent-quickstart/ and does not touch any localized files.

Confirmed by checking the last 5 workflow runs on this repo: all show the same conclusion: "failure" from the same locale check, including unrelated PRs (#1448, #1449) and translation-bot PRs.


Generated by Claude Code

This branch was successfully deployed

1 active deployment
staging — 1d061eb6 Deployed Sep 30, 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