docs: add agent quickstart guides for all SDK languages - #1171
Draft
ericciarla wants to merge 1 commit into
Draft
Conversation
Add canonical one-file-per-language quickstart docs for external agents covering search, scrape, and interact endpoints with complete parameter references generated from SDK source and OpenAPI spec. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KoxS5ZeK35jDjRB57NjzEP
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary\n\n- Adds canonical one-file-per-language agent quickstart docs covering
search,scrape, andinteractendpoints\n- Covers all five SDK languages: Node.js/TypeScript, Python, Rust, Java, and Elixir\n- Each file includes install, auth, endpoint examples, and complete parameter references\n- Generated from SDK source code and OpenAPI spec as the sources of truth\n\n## Files added\n\n-agent-quickstart/node.mdx— JavaScript/TypeScript (camelCase, Zod schema support,promptfor interact)\n-agent-quickstart/python.mdx— Python (snake_case, async variant,promptfor interact)\n-agent-quickstart/rust.mdx— Rust (async-only, struct-based options,promptfor interact)\n-agent-quickstart/java.mdx— Java (builder pattern, overloads, code-only interact)\n-agent-quickstart/elixir.mdx— Elixir (auto-generated function names, keyword lists, code-only interact)\n\n## Key design decisions\n\n- SDK source is treated as primary authority, OpenAPI as secondary confirmation\n- Language-specific differences are documented explicitly (e.g., Java/Elixir interact lacksprompt; Elixir has verbose auto-generated function names; Python accepts both snake_case and camelCase format strings)\n- Deprecated aliases listed in Notes sections only, never as the preferred path\n- Parameters only documented when confirmed in SDK source — nothing invented\n\n## Test plan\n\n- [ ] Verify each .mdx file renders cleanly in Mintlify\n- [ ] Spot-check parameter lists against SDK source for each language\n- [ ] Confirm examples use correct method signatures\n\n---\n_Generated by Claude Code_Generated by Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.