Skip to content

docs(agent-quickstart): add per-language quickstarts for search, scrape, and interact - #1236

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

docs(agent-quickstart): add per-language quickstarts for search, scrape, and interact#1236
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-0siop6

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds a new agent-quickstart/ directory with one canonical quickstart document per SDK language: Node.js, Python, Rust, Java, and Elixir
  • Each file covers search, scrape, and interact endpoints with method signatures, parameter tables, realistic examples, and language-specific notes
  • Generated from SDK source code and the v2 OpenAPI spec (not copied from existing docs)

What's in each file

  • Install — exact package name and install command
  • Authenticate — minimal auth setup with constructor options
  • When To Use What — one-line guidance for search vs scrape vs interact
  • Search / Scrape / Interact — each with: why use it, preferred SDK method, working example, full parameter table, return value description
  • Notes — language-specific caveats, deprecated aliases, naming differences
  • Source Of Truth — exact source files used

Source files consulted

  • firecrawl/apps/js-sdk/firecrawl/src/v2/client.ts + types.ts
  • firecrawl/apps/python-sdk/firecrawl/v2/client.py + types.py
  • firecrawl/apps/rust-sdk/src/client.rs + scrape.rs + search.rs
  • firecrawl/apps/java-sdk/src/main/java/com/firecrawl/client/FirecrawlClient.java
  • firecrawl/apps/elixir-sdk/lib/firecrawl.ex
  • firecrawl-docs/api-reference/v2-openapi.json

Relationship to existing docs

These quickstarts complement the existing agent-source-of-truth/ files. The source-of-truth files are exhaustive references; the quickstarts are concise, self-contained documents designed to be pasted into agent context for fast onboarding.

Test plan

  • Verify each .mdx file renders cleanly in Mintlify
  • Spot-check parameter tables against current SDK source
  • Confirm no localized files were modified

Generated by Claude Code

…pe, and interact

Generated from SDK source and OpenAPI spec. One file per language
(Node.js, Python, Rust, Java, Elixir) covering search, scrape, and
interact with method signatures, parameter tables, and examples.

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

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