Skip to content

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

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

docs: add agent quickstart files for all SDK languages#1344
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-bp6ecj

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart file per SDK language in agent-quickstart/: Node.js, Python, Rust, Java, and Elixir.
  • Each file covers the search, scrape, and interact endpoints with confirmed parameters, realistic examples, and language-specific notes.
  • Generated from SDK source code and the v2 OpenAPI spec — SDK source is the primary authority, OpenAPI confirms the HTTP contract.

Files added

File Language Source
agent-quickstart/node.mdx JavaScript/TypeScript firecrawl npm package, v2 client + types
agent-quickstart/python.mdx Python firecrawl-py PyPI package, v2 client + types
agent-quickstart/rust.mdx Rust firecrawl crate, v2 client + types
agent-quickstart/java.mdx Java firecrawl-java Maven artifact, FirecrawlClient
agent-quickstart/elixir.mdx Elixir firecrawl hex package, auto-generated module

Structure per file

Each quickstart follows a consistent structure:

  1. Install command
  2. Auth example
  3. When To Use What (search vs scrape vs interact)
  4. Search — method, example, full parameter table
  5. Scrape — method, example, full parameter table
  6. Interact — method, example, parameter table
  7. Notes — language-specific caveats, deprecated aliases, naming conventions
  8. Source Of Truth — exact source files used

Language-specific differences documented

  • Java and Elixir SDKs only expose code for interact (no prompt parameter) — documented in Notes.
  • Elixir function names are auto-generated and verbose (scrape_and_extract_from_url, interact_with_scrape_browser_session) — documented as-is, no aliases invented.
  • Rust uses ..Default::default() pattern for option structs — examples show idiomatic usage.
  • Python uses snake_case exclusively in method signatures; types accept both snake_case and camelCase via Pydantic aliases.
  • Node.js uses camelCase exclusively.

Test plan

  • Verify each .mdx file renders cleanly in Mintlify
  • Confirm parameter tables are accurate against current SDK versions
  • Check code examples compile/run against latest SDK releases

Generated by Claude Code

Add one canonical quickstart per SDK language in agent-quickstart/,
covering search, scrape, and interact endpoints with confirmed parameters,
examples, and language-specific notes. Generated from SDK source code and
the v2 OpenAPI spec.

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Sep 1, 2026, 1:24 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