Skip to content

docs: add agent quickstart guides for 5 SDK languages - #1412

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart document per SDK language: Node/TypeScript, Python, Rust, Java, and Elixir
  • Each file lives at agent-quickstart/<language>.mdx and covers the three core endpoints: search, scrape, and interact
  • Every file includes: install command, auth pattern, when-to-use guidance, SDK method names, realistic examples, and a complete parameter table confirmed from SDK source
  • Adds an "Agent Quickstarts" navigation group under the "Build with AI" tab in docs.json

What's in each quickstart

  • What the endpoint is for and when to use it
  • Exact SDK method name (preferred, not deprecated)
  • Minimal working example
  • Every confirmed parameter with type, description, and defaults where explicit in source
  • Language-specific naming differences (camelCase vs snake_case, OpenAPI-derived names in Elixir)
  • Deprecated aliases listed as migration notes only

Source of truth

All content was generated from:

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

Files changed

  • agent-quickstart/node.mdx (new)
  • agent-quickstart/python.mdx (new)
  • agent-quickstart/rust.mdx (new)
  • agent-quickstart/java.mdx (new)
  • agent-quickstart/elixir.mdx (new)
  • docs.json (navigation update)

🤖 Generated with Claude Code

https://claude.ai/code/session_01GYKofnYR7RoLUMqLGa27gG


Generated by Claude Code

…lixir

One canonical quickstart file per SDK language covering search, scrape,
and interact endpoints. Each file is generated from SDK source and the
OpenAPI spec, with every confirmed parameter documented. Added navigation
group under "Build with AI" tab.

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

mintlify Bot commented Sep 13, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 13, 2026, 1:16 PM

💡 Tip: Enable Automations 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