Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart document per SDK language in agent-quickstart/: Node.js, Python, Rust, Java, and Elixir
  • Each file covers search, scrape, and interact with current SDK method signatures, realistic examples, and every confirmed parameter with short descriptions
  • Generated from latest SDK source (JS 4.35.0, Python 4.38.0, Rust 2.16.0, Java 1.15.0, Elixir 1.9.2) cross-referenced against the v2 OpenAPI spec
  • Includes recently added parameters: lockdown, redactPII, auditMetadata, includeDomains/excludeDomains, highlights, enterprise, threatProtection, and new format types (product, menu, question, highlights)
  • Documents language-specific naming differences (camelCase vs snake_case vs Rust enums vs Elixir atoms) and SDK quirks (e.g. Java has code-only interact, Elixir uses OpenAPI-generated function names)

Files added

File Language SDK Version
agent-quickstart/node.mdx Node.js / TypeScript 4.35.0
agent-quickstart/python.mdx Python 4.38.0
agent-quickstart/rust.mdx Rust 2.16.0
agent-quickstart/java.mdx Java 1.15.0
agent-quickstart/elixir.mdx Elixir 1.9.2

Test plan

  • Verify each .mdx file renders correctly as a Mintlify docs page
  • Spot-check parameter lists against current SDK source for accuracy
  • Confirm code examples are syntactically valid
  • Add navigation entries in docs.json if these pages should appear in the sidebar

Generated by Claude Code

One canonical quickstart per language (Node.js, Python, Rust, Java, Elixir)
in agent-quickstart/. Each covers search, scrape, and interact with current
SDK parameters, examples, and method signatures.

Generated from latest SDK source (JS 4.35.0, Python 4.38.0, Rust 2.16.0,
Java 1.15.0, Elixir 1.9.2) cross-referenced against the v2 OpenAPI spec.
Includes new parameters like lockdown, redactPII, auditMetadata,
includeDomains/excludeDomains, and highlights across all languages.
@mintlify

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