docs(ai-gateway): publish AI Gateway module reference#231
Open
sam-prais wants to merge 4 commits into
Open
Conversation
The AI Gateway module's JSDoc was already updated in #226, but the types were never added to the docs pipeline whitelist, so the module never appeared in the generated SDK reference. Add AiGatewayModule and AiGatewayConnection to the docs pipeline, and rewrite the JSDoc for reference quality: explain what an OpenAI-compatible client is, clarify that the credit quota is shared across all app users (not per-user), link to the current model list, and split the growing intro into Models / Authentication Modes / Billing and limits sections.
Contributor
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/sdk@0.8.39-pr.231.ef80ef9Prefer not to change any import paths? Install using npm alias so your code still imports npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.39-pr.231.ef80ef9"Or add it to your {
"dependencies": {
"@base44/sdk": "npm:@base44-preview/sdk@0.8.39-pr.231.ef80ef9"
}
}
Preview published to npm registry — try new features instantly! |
yardend-wix
reviewed
Jul 15, 2026
yardend-wix
reviewed
Jul 15, 2026
Correct the misleading security claim that calling from a backend function keeps the token out of the browser — it's the same session token already used for every other SDK call. The real reason to use a backend function is code integrity: your instructions, tools, and business logic stay server-side where you can enforce your own auth, rate, and spend limits. Also show where the base44 client comes from in both examples (createClientFromRequest), instead of using a bare base44 with no indication of its origin.
Contributor
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
yardend-wix
reviewed
Jul 15, 2026
claude_opus_4_8 is behind a feature flag and not open to users yet.
Contributor
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
yardend-wix
approved these changes
Jul 15, 2026
wixysam
reviewed
Jul 16, 2026
…ple length Tighten the backend-function rationale, merge the redundant Models intro sentence into the model-options pointer, correct the Authentication Modes section (no permission difference between modes, just which token is returned), note that per-user usage limits are left to the caller to build, and shorten both example tab titles.
Contributor
|
Claude encountered an error —— View job I'll analyze this and get back to 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
3 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
base44.aiGateway/base44.asServiceRole.aiGateway) had JSDoc from fix(ai-gateway): resolve gateway by app id in the path #226 but was never added to the docs pipeline whitelist, so it never appeared in the generated SDK reference.AiGatewayModuleandAiGatewayConnectiontotypes-to-expose.json, and addAiGatewayConnectiontotypes-to-delete-after-processing.json(same pattern asDeleteResult/ImportResult: keep it inline in theconnection()method'sReturnsaccordion, without a redundant standalone/appended section).InvokeLLM'smodelparam) instead of hardcoding a list that will drift.## Models,## Authentication Modes, and## Billing and limitssections, matching the Agents/Auth/Functions module pages.@example(plain OpenAI SDK call) ahead of the existing tool-loop agent example, per the "start simple" convention.Test plan
npm test— 180/180 passingnpm run create-docs— verified the generated page has no duplicateAiGatewayConnection/Propertiessection and no stray standalone nav pagemint devagainst the pairedmintlify-docsbranch