@base44-preview/sdk 0.8.39-pr.231.cbd75f8 → 0.8.39-pr.232.affea8a

package/dist/modules/ai-gateway.types.d.ts

@@ -1,13 +1,13 @@
 /**
- * Connection details for the Base44 AI Gateway.
+ * A connection to the Base44 AI Gateway.
+ *
+ * Contains the base URL and bearer token to use with any OpenAI-compatible
+ * client pointed at the Base44 AI Gateway.
  */
 export interface AiGatewayConnection {
-    /** Base URL of the gateway's OpenAI-compatible Chat Completions endpoint. */
+    /** Base URL of the gateway's OpenAI-compatible endpoint. */
     baseURL: string;
-    /**
-     * Bearer token that authenticates the request. Empty string when the caller is
-     * unauthenticated.
-     */
+    /** Bearer token used to authenticate requests to the gateway. */
     token: string;
 }
 /**
@@ -25,47 +25,13 @@ export interface AiGatewayModuleConfig {
 /**
  * AI Gateway module for calling Base44's managed AI models from your own code.
  *
- * `connection()` hands you a `baseURL` and `token` that authenticate as your
- * Base44 app. An OpenAI-compatible client is any library, such as the `openai`
- * SDK or the Vercel AI SDK, that has the same request and response format
- * as OpenAI's Chat Completions API and lets you point it at a custom `baseURL`
- * instead of OpenAI's own servers. Pass `connection()`'s values to one of
- * these clients and it works against Base44's gateway exactly as it would
- * against the provider directly, no separate account, API key, or billing
- * setup with the underlying model provider required.
- *
- * Call `connection()` from a backend function rather than the browser. That's
- * where your instructions, tools, and business logic stay server-side, where
- * users can't inspect or tamper with them, and where you can enforce your own
- * auth checks, rate limits, or spend limits around the call. `token` is the
- * caller's own session token, the same one the SDK already uses for every
- * other call, so calling from the browser doesn't expose anything new.
- *
- * ## Models
- *
- * Build AI agents or call models directly from your app's backend functions.
- * Pass `'automatic'` to let Base44 choose a model, or pin a specific one such
- * as `'claude_sonnet_4_6'`, `'gpt_5_5'`, or `'gemini_3_1_pro'`.
- *
- * See the [`model` options on `InvokeLLM`](/developers/references/sdk/docs/type-aliases/integrations#invokellm)
- * for the current set of models you can use.
- *
- * ## Authentication Modes
- *
- * This module is available to use with a client in all authentication modes:
- *
- * - **Anonymous or User authentication** (`base44.aiGateway`): The gateway connection is scoped to the current user's permissions.
- * - **Service role authentication** (`base44.asServiceRole.aiGateway`): The gateway connection uses the service role for backend code that needs elevated permissions.
- *
- * ## Billing and limits
+ * The gateway exposes an OpenAI-compatible Chat Completions endpoint, so any
+ * OpenAI-compatible SDK works against it:
+ * - Build custom AI agents or call models directly from your backend code
+ * - Uses your app's models, billing, and credit quota, no API key to manage
  *
- * Requests are billed to your app's credit quota, which is the same shared
- * quota your app's built-in AI features use, and isn't split per user. If the
- * app runs out of credits, the gateway stops working for every user of the
- * app until the quota resets. A request is rejected before the model runs if
- * the app is out of credits.
- *
- * Streaming responses aren't supported yet, so leave `stream` unset on your requests.
+ * Available in user authentication mode (`base44.aiGateway`) and with the
+ * service-role token via `base44.asServiceRole.aiGateway`.
  */
 export interface AiGatewayModule {
     /**
@@ -73,36 +39,19 @@ export interface AiGatewayModule {
      *
      * Returns the `baseURL` and `token` to pass to any OpenAI-compatible client.
      *
-     * @returns The gateway {@linkcode AiGatewayConnection | connection} (`baseURL` and `token`).
-     *
-     * @example
-     * ```typescript
-     * // Call a model directly with the OpenAI SDK, inside a backend function
-     * import { createClientFromRequest } from "@base44/sdk";
-     * import OpenAI from "openai";
+     * The `token` is the current caller's bearer token: the app user's token for
+     * `base44.aiGateway`, or the service-role token for `base44.asServiceRole.aiGateway`.
+     * When the caller is unauthenticated, `token` is an empty string.
      *
-     * const base44 = createClientFromRequest(request);
-     * const { baseURL, token } = base44.aiGateway.connection();
-     * const openai = new OpenAI({ baseURL, apiKey: token });
-     *
-     * const response = await openai.chat.completions.create({
-     *   model: "automatic",
-     *   messages: [{ role: "user", content: "Summarize this week's top support tickets." }],
-     * });
-     *
-     * console.log(response.choices[0].message.content);
-     * ```
+     * @returns The gateway {@linkcode AiGatewayConnection | connection} (`baseURL` and `token`).
      *
      * @example
      * ```typescript
-     * // Review a return request with a tool-using agent, inside a backend function
-     * import { createClientFromRequest } from "@base44/sdk";
      * import { ToolLoopAgent, tool, stepCountIs, hasToolCall } from "ai";
      * import { createOpenAICompatible } from "@ai-sdk/openai-compatible";
      * import { z } from "zod";
      *
-     * const base44 = createClientFromRequest(request);
-     * const returnRequest = await base44.entities.ReturnRequest.get(returnId);
+     * const request = await base44.entities.ReturnRequest.get(returnId);
      * const { baseURL, token } = base44.aiGateway.connection();
      * // Point any OpenAI-compatible client at `baseURL` with `apiKey: token`.
      * const models = createOpenAICompatible({ name: "base44", baseURL, apiKey: token });
@@ -117,7 +66,7 @@ export interface AiGatewayModule {
      *       description: "This customer's past orders, optionally filtered by status",
      *       inputSchema: z.object({ status: z.string().optional() }),
      *       execute: ({ status }) => {
-     *         const query = { customer_email: returnRequest.customer_email };
+     *         const query = { customer_email: request.customer_email };
      *         if (status) query.status = status;
      *         return base44.entities.Order.filter(query, "-created_date", 50);
      *       },
@@ -132,7 +81,7 @@ export interface AiGatewayModule {
      *   stopWhen: [stepCountIs(8), hasToolCall("submitVerdict")],
      * });
      *
-     * await agent.generate({ prompt: `Review this return request: ${JSON.stringify(returnRequest)}` });
+     * await agent.generate({ prompt: `Review this return request: ${JSON.stringify(request)}` });
      * ```
      */
     connection(): AiGatewayConnection;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.39-pr.231.cbd75f8",
+  "version": "0.8.39-pr.232.affea8a",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",