docs: document authenticated endpoints and API key usage#67
Conversation
The API-key URL format only existed in a blog post. Adds a dedicated page: unified endpoint format, legacy formats, keyed curl example, SDK usage, rate limit guidance, and key safety notes. Linked from the sidebar and the public endpoints page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR adds a new authenticated wallet API documentation page, then updates the public-endpoints note, sidebar navigation, and an Instagas example to point to the new canonical URL format. ChangesAuthenticated Endpoints Docs
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/wallet/api/authenticated-endpoints.md`:
- Around line 15-17: The markdown examples in authenticated-endpoints.md still
have unlabeled code fences, so update each affected fenced block to use the
correct language tag for syntax highlighting and to clear the markdownlint
warning. Find the examples around the documented endpoints and label them as
bash, json, or typescript as appropriate, keeping the existing content unchanged
while only adjusting the fence identifiers.
In `@docs/wallet/api/public-endpoints.md`:
- Line 40: The callout text uses “signup” as one word, but it should read “sign
up” for proper grammar. Update the wording in the public-endpoints documentation
callout so the sentence around Candide's Dashboard uses the two-word phrase,
keeping the rest of the message unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 209a6901-69b9-467b-99b3-685930a9bb97
📒 Files selected for processing (3)
docs/wallet/api/authenticated-endpoints.mddocs/wallet/api/public-endpoints.mdsidebars.js
| ``` | ||
| https://api.candide.dev/api/v3/{CHAIN_ID}/{API_KEY} | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Tag the unlabeled code fences.
These examples still lack language identifiers, which keeps the markdownlint warning open and removes syntax highlighting. Please mark them as bash, json, and typescript as appropriate.
Also applies to: 21-23, 31-34
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/wallet/api/authenticated-endpoints.md` around lines 15 - 17, The
markdown examples in authenticated-endpoints.md still have unlabeled code
fences, so update each affected fenced block to use the correct language tag for
syntax highlighting and to clear the markdownlint warning. Find the examples
around the documented endpoints and label them as bash, json, or typescript as
appropriate, keeping the existing content unchanged while only adjusting the
fence identifiers.
Source: Linters/SAST tools
|
|
||
| :::info | ||
| Need Higher Limits? For production use or higher rate limits, signup on [Candide's Dashboard](https://dashboard.candide.dev) to get your own Bundler and Paymaster URLs. | ||
| Need Higher Limits? For production use or higher rate limits, signup on [Candide's Dashboard](https://dashboard.candide.dev) to get your own Bundler and Paymaster URLs. See [API Keys & Endpoints](/wallet/api/authenticated-endpoints/) for the URL format and setup. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use “sign up” instead of “signup”.
Small grammar fix in the new callout.
🧰 Tools
🪛 LanguageTool
[grammar] ~40-~40: Ensure spelling is correct
Context: ...r production use or higher rate limits, signup on [Candide's Dashboard](https://dashbo...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/wallet/api/public-endpoints.md` at line 40, The callout text uses
“signup” as one word, but it should read “sign up” for proper grammar. Update
the wording in the public-endpoints documentation callout so the sentence around
Candide's Dashboard uses the two-word phrase, keeping the rest of the message
unchanged.
Source: Linters/SAST tools
Removes the legacy formats section in favor of a deprecation caution, and updates the one code example still using the old paymaster URL format to the unified endpoint. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 participant
What
The authenticated endpoint contract existed only in the July 2025 release blog post; the docs told developers to "get your URL from the dashboard" without ever showing the URL format. This adds
wallet/api/authenticated-endpoints:https://api.candide.dev/api/v3/{CHAIN_ID}/{API_KEY}serving both Bundler and Paymaster; the old per-service formats are marked deprecated (per Marco), and the one code example still using them (InstaGas batch-sponsor page) is updated to the unified formateth_supportedEntryPointsresponseBundlerandCandidePaymaster)Needs your input before merge
Rate limits are still qualitative. If you can share numbers (public per-IP limit, per-tier request ceilings), I'll add a table; the section is structured to take one.
Verification
yarn buildpasses with no broken links.🤖 Generated with Claude Code
Summary by CodeRabbit