@browserbasehq/orca 3.2.0-preview.4 → 3.2.1-preview.0

package/dist/cjs/lib/v3/types/public/api.d.ts

@@ -9,6 +9,7 @@
  * All TypeScript types are inferred from the Zod4 *Schemas using z.infer<>
  */
 import { z } from "zod/v4";
+export { VariablePrimitiveSchema, VariableValueSchema, VariablesSchema, } from "./variables.js";
 /** Browser launch options for local browsers */
 export declare const LocalBrowserLaunchOptionsSchema: z.ZodObject<{
     args: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -52,6 +53,7 @@ export declare const ModelConfigObjectSchema: z.ZodObject<{
     modelName: z.ZodString;
     apiKey: z.ZodOptional<z.ZodString>;
     baseURL: z.ZodOptional<z.ZodString>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, z.core.$strip>;
 /** Model configuration */
 export declare const ModelConfigSchema: z.ZodObject<{
@@ -65,6 +67,7 @@ export declare const ModelConfigSchema: z.ZodObject<{
     modelName: z.ZodString;
     apiKey: z.ZodOptional<z.ZodString>;
     baseURL: z.ZodOptional<z.ZodString>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, z.core.$strip>;
 /** Action object returned by observe and used by act */
 export declare const ActionSchema: z.ZodObject<{
@@ -181,6 +184,8 @@ export declare const BrowserbaseContextSchema: z.ZodObject<{
 export declare const BrowserbaseBrowserSettingsSchema: z.ZodObject<{
     advancedStealth: z.ZodOptional<z.ZodBoolean>;
     blockAds: z.ZodOptional<z.ZodBoolean>;
+    captchaImageSelector: z.ZodOptional<z.ZodString>;
+    captchaInputSelector: z.ZodOptional<z.ZodString>;
     context: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         persist: z.ZodOptional<z.ZodBoolean>;
@@ -217,8 +222,16 @@ export declare const BrowserbaseBrowserSettingsSchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>>;
     logSession: z.ZodOptional<z.ZodBoolean>;
+    os: z.ZodOptional<z.ZodEnum<{
+        mobile: "mobile";
+        linux: "linux";
+        windows: "windows";
+        mac: "mac";
+        tablet: "tablet";
+    }>>;
     recordSession: z.ZodOptional<z.ZodBoolean>;
     solveCaptchas: z.ZodOptional<z.ZodBoolean>;
+    verified: z.ZodOptional<z.ZodBoolean>;
     viewport: z.ZodOptional<z.ZodObject<{
         width: z.ZodOptional<z.ZodNumber>;
         height: z.ZodOptional<z.ZodNumber>;
@@ -277,6 +290,8 @@ export declare const BrowserbaseSessionCreateParamsSchema: z.ZodObject<{
     browserSettings: z.ZodOptional<z.ZodObject<{
         advancedStealth: z.ZodOptional<z.ZodBoolean>;
         blockAds: z.ZodOptional<z.ZodBoolean>;
+        captchaImageSelector: z.ZodOptional<z.ZodString>;
+        captchaInputSelector: z.ZodOptional<z.ZodString>;
         context: z.ZodOptional<z.ZodObject<{
             id: z.ZodString;
             persist: z.ZodOptional<z.ZodBoolean>;
@@ -313,8 +328,16 @@ export declare const BrowserbaseSessionCreateParamsSchema: z.ZodObject<{
             }, z.core.$strip>>;
         }, z.core.$strip>>;
         logSession: z.ZodOptional<z.ZodBoolean>;
+        os: z.ZodOptional<z.ZodEnum<{
+            mobile: "mobile";
+            linux: "linux";
+            windows: "windows";
+            mac: "mac";
+            tablet: "tablet";
+        }>>;
         recordSession: z.ZodOptional<z.ZodBoolean>;
         solveCaptchas: z.ZodOptional<z.ZodBoolean>;
+        verified: z.ZodOptional<z.ZodBoolean>;
         viewport: z.ZodOptional<z.ZodObject<{
             width: z.ZodOptional<z.ZodNumber>;
             height: z.ZodOptional<z.ZodNumber>;
@@ -356,6 +379,8 @@ export declare const SessionStartRequestSchema: z.ZodObject<{
         browserSettings: z.ZodOptional<z.ZodObject<{
             advancedStealth: z.ZodOptional<z.ZodBoolean>;
             blockAds: z.ZodOptional<z.ZodBoolean>;
+            captchaImageSelector: z.ZodOptional<z.ZodString>;
+            captchaInputSelector: z.ZodOptional<z.ZodString>;
             context: z.ZodOptional<z.ZodObject<{
                 id: z.ZodString;
                 persist: z.ZodOptional<z.ZodBoolean>;
@@ -392,8 +417,16 @@ export declare const SessionStartRequestSchema: z.ZodObject<{
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
             logSession: z.ZodOptional<z.ZodBoolean>;
+            os: z.ZodOptional<z.ZodEnum<{
+                mobile: "mobile";
+                linux: "linux";
+                windows: "windows";
+                mac: "mac";
+                tablet: "tablet";
+            }>>;
             recordSession: z.ZodOptional<z.ZodBoolean>;
             solveCaptchas: z.ZodOptional<z.ZodBoolean>;
+            verified: z.ZodOptional<z.ZodBoolean>;
             viewport: z.ZodOptional<z.ZodObject<{
                 width: z.ZodOptional<z.ZodNumber>;
                 height: z.ZodOptional<z.ZodNumber>;
@@ -500,8 +533,9 @@ export declare const ActOptionsSchema: z.ZodOptional<z.ZodObject<{
         modelName: z.ZodString;
         apiKey: z.ZodOptional<z.ZodString>;
         baseURL: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>, z.ZodString]>>;
-    variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    variables: z.ZodOptional<z.ZodType<import("./agent.js").Variables, unknown, z.core.$ZodTypeInternals<import("./agent.js").Variables, unknown>>>;
     timeout: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>>;
 export declare const ActRequestSchema: z.ZodObject<{
@@ -524,8 +558,9 @@ export declare const ActRequestSchema: z.ZodObject<{
             modelName: z.ZodString;
             apiKey: z.ZodOptional<z.ZodString>;
             baseURL: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, z.core.$strip>, z.ZodString]>>;
-        variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        variables: z.ZodOptional<z.ZodType<import("./agent.js").Variables, unknown, z.core.$ZodTypeInternals<import("./agent.js").Variables, unknown>>>;
         timeout: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
     frameId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -589,6 +624,7 @@ export declare const ExtractOptionsSchema: z.ZodOptional<z.ZodObject<{
         modelName: z.ZodString;
         apiKey: z.ZodOptional<z.ZodString>;
         baseURL: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>, z.ZodString]>>;
     timeout: z.ZodOptional<z.ZodNumber>;
     selector: z.ZodOptional<z.ZodString>;
@@ -608,6 +644,7 @@ export declare const ExtractRequestSchema: z.ZodObject<{
             modelName: z.ZodString;
             apiKey: z.ZodOptional<z.ZodString>;
             baseURL: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, z.core.$strip>, z.ZodString]>>;
         timeout: z.ZodOptional<z.ZodNumber>;
         selector: z.ZodOptional<z.ZodString>;
@@ -638,7 +675,9 @@ export declare const ObserveOptionsSchema: z.ZodOptional<z.ZodObject<{
         modelName: z.ZodString;
         apiKey: z.ZodOptional<z.ZodString>;
         baseURL: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>, z.ZodString]>>;
+    variables: z.ZodOptional<z.ZodType<import("./agent.js").Variables, unknown, z.core.$ZodTypeInternals<import("./agent.js").Variables, unknown>>>;
     timeout: z.ZodOptional<z.ZodNumber>;
     selector: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>>;
@@ -656,7 +695,9 @@ export declare const ObserveRequestSchema: z.ZodObject<{
             modelName: z.ZodString;
             apiKey: z.ZodOptional<z.ZodString>;
             baseURL: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, z.core.$strip>, z.ZodString]>>;
+        variables: z.ZodOptional<z.ZodType<import("./agent.js").Variables, unknown, z.core.$ZodTypeInternals<import("./agent.js").Variables, unknown>>>;
         timeout: z.ZodOptional<z.ZodNumber>;
         selector: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
@@ -705,6 +746,7 @@ export declare const AgentConfigSchema: z.ZodObject<{
         modelName: z.ZodString;
         apiKey: z.ZodOptional<z.ZodString>;
         baseURL: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>, z.ZodString]>>;
     systemPrompt: z.ZodOptional<z.ZodString>;
     cua: z.ZodOptional<z.ZodBoolean>;
@@ -724,6 +766,7 @@ export declare const AgentConfigSchema: z.ZodObject<{
         modelName: z.ZodString;
         apiKey: z.ZodOptional<z.ZodString>;
         baseURL: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>, z.ZodString]>>;
 }, z.core.$strip>;
 /** Action taken by the agent during execution */
@@ -777,6 +820,8 @@ export declare const AgentExecuteOptionsSchema: z.ZodObject<{
     instruction: z.ZodString;
     maxSteps: z.ZodOptional<z.ZodNumber>;
     highlightCursor: z.ZodOptional<z.ZodBoolean>;
+    useSearch: z.ZodOptional<z.ZodBoolean>;
+    toolTimeout: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export declare const AgentExecuteRequestSchema: z.ZodObject<{
     agentConfig: z.ZodObject<{
@@ -798,6 +843,7 @@ export declare const AgentExecuteRequestSchema: z.ZodObject<{
             modelName: z.ZodString;
             apiKey: z.ZodOptional<z.ZodString>;
             baseURL: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, z.core.$strip>, z.ZodString]>>;
         systemPrompt: z.ZodOptional<z.ZodString>;
         cua: z.ZodOptional<z.ZodBoolean>;
@@ -817,12 +863,15 @@ export declare const AgentExecuteRequestSchema: z.ZodObject<{
             modelName: z.ZodString;
             apiKey: z.ZodOptional<z.ZodString>;
             baseURL: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, z.core.$strip>, z.ZodString]>>;
     }, z.core.$strip>;
     executeOptions: z.ZodObject<{
         instruction: z.ZodString;
         maxSteps: z.ZodOptional<z.ZodNumber>;
         highlightCursor: z.ZodOptional<z.ZodBoolean>;
+        useSearch: z.ZodOptional<z.ZodBoolean>;
+        toolTimeout: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>;
     frameId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     streamResponse: z.ZodOptional<z.ZodBoolean>;
@@ -1042,11 +1091,9 @@ export declare const StreamEventLogDataSchema: z.ZodObject<{
 /**
  * SSE stream event sent during streaming responses.
  *
- * IMPORTANT: Key ordering matters for Stainless SDK generation.
- * The `data` field MUST be serialized first, with `status` as the first key within it.
- * This allows Stainless to use `data_starts_with: '{"data":{"status":"finished"'` for event handling.
- *
- * Expected serialization order: {"data":{"status":...},"type":...,"id":...}
+ * The SSE wire format includes an `event:` line that mirrors the stream status
+ * (`starting`, `connected`, `running`, `finished`, or `error`) followed by a
+ * JSON `data:` line containing the typed payload below.
  */
 export declare const StreamEventSchema: z.ZodObject<{
     data: z.ZodUnion<readonly [z.ZodObject<{

package/dist/cjs/lib/v3/types/public/api.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NavigateResultSchema = exports.NavigateRequestSchema = exports.NavigateOptionsSchema = exports.AgentExecuteResponseSchema = exports.AgentExecuteResultSchema = exports.AgentExecuteRequestSchema = exports.AgentExecuteOptionsSchema = exports.AgentCacheEntrySchema = exports.AgentResultDataSchema = exports.AgentUsageSchema = exports.AgentActionSchema = exports.AgentConfigSchema = exports.ObserveResponseSchema = exports.ObserveResultSchema = exports.ObserveRequestSchema = exports.ObserveOptionsSchema = exports.ExtractResponseSchema = exports.ExtractResultSchema = exports.ExtractRequestSchema = exports.ExtractOptionsSchema = exports.ActResponseSchema = exports.ActResultSchema = exports.ActResultDataSchema = exports.ActRequestSchema = exports.ActOptionsSchema = exports.SessionEndResponseSchema = exports.SessionEndResultSchema = exports.SessionEndRequestSchema = exports.SessionStartResponseSchema = exports.SessionStartResultSchema = exports.SessionStartRequestSchema = exports.BrowserbaseSessionCreateParamsSchema = exports.BrowserbaseRegionSchema = exports.ProxyConfigSchema = exports.ExternalProxyConfigSchema = exports.BrowserbaseProxyConfigSchema = exports.BrowserbaseProxyGeolocationSchema = exports.BrowserbaseBrowserSettingsSchema = exports.BrowserbaseContextSchema = exports.BrowserbaseFingerprintSchema = exports.BrowserbaseFingerprintScreenSchema = exports.BrowserbaseViewportSchema = exports.ErrorResponseSchema = exports.SessionHeadersSchema = exports.BrowserConfigSchema = exports.SessionIdParamsSchema = exports.ActionSchema = exports.ModelConfigSchema = exports.ModelConfigObjectSchema = exports.LocalBrowserLaunchOptionsSchema = void 0;
-exports.Operations = exports.openApiLinks = exports.openApiSecuritySchemes = exports.StreamEventSchema = exports.StreamEventLogDataSchema = exports.StreamEventSystemDataSchema = exports.StreamEventTypeSchema = exports.StreamEventStatusSchema = exports.ReplayResponseSchema = exports.ReplayResultSchema = exports.ReplayPageSchema = exports.ReplayActionSchema = exports.TokenUsageSchema = exports.NavigateResponseSchema = void 0;
+exports.AgentExecuteResponseSchema = exports.AgentExecuteResultSchema = exports.AgentExecuteRequestSchema = exports.AgentExecuteOptionsSchema = exports.AgentCacheEntrySchema = exports.AgentResultDataSchema = exports.AgentUsageSchema = exports.AgentActionSchema = exports.AgentConfigSchema = exports.ObserveResponseSchema = exports.ObserveResultSchema = exports.ObserveRequestSchema = exports.ObserveOptionsSchema = exports.ExtractResponseSchema = exports.ExtractResultSchema = exports.ExtractRequestSchema = exports.ExtractOptionsSchema = exports.ActResponseSchema = exports.ActResultSchema = exports.ActResultDataSchema = exports.ActRequestSchema = exports.ActOptionsSchema = exports.SessionEndResponseSchema = exports.SessionEndResultSchema = exports.SessionEndRequestSchema = exports.SessionStartResponseSchema = exports.SessionStartResultSchema = exports.SessionStartRequestSchema = exports.BrowserbaseSessionCreateParamsSchema = exports.BrowserbaseRegionSchema = exports.ProxyConfigSchema = exports.ExternalProxyConfigSchema = exports.BrowserbaseProxyConfigSchema = exports.BrowserbaseProxyGeolocationSchema = exports.BrowserbaseBrowserSettingsSchema = exports.BrowserbaseContextSchema = exports.BrowserbaseFingerprintSchema = exports.BrowserbaseFingerprintScreenSchema = exports.BrowserbaseViewportSchema = exports.ErrorResponseSchema = exports.SessionHeadersSchema = exports.BrowserConfigSchema = exports.SessionIdParamsSchema = exports.ActionSchema = exports.ModelConfigSchema = exports.ModelConfigObjectSchema = exports.LocalBrowserLaunchOptionsSchema = exports.VariablesSchema = exports.VariableValueSchema = exports.VariablePrimitiveSchema = void 0;
+exports.Operations = exports.openApiLinks = exports.openApiSecuritySchemes = exports.StreamEventSchema = exports.StreamEventLogDataSchema = exports.StreamEventSystemDataSchema = exports.StreamEventTypeSchema = exports.StreamEventStatusSchema = exports.ReplayResponseSchema = exports.ReplayResultSchema = exports.ReplayPageSchema = exports.ReplayActionSchema = exports.TokenUsageSchema = exports.NavigateResponseSchema = exports.NavigateResultSchema = exports.NavigateRequestSchema = exports.NavigateOptionsSchema = void 0;
 /**
  * Centralized Zod schemas for Stagehand Server API
  *
@@ -13,6 +13,11 @@ exports.Operations = exports.openApiLinks = exports.openApiSecuritySchemes = exp
  * All TypeScript types are inferred from the Zod4 *Schemas using z.infer<>
  */
 const v4_1 = require("zod/v4");
+const variables_js_1 = require("./variables.js");
+var variables_js_2 = require("./variables.js");
+Object.defineProperty(exports, "VariablePrimitiveSchema", { enumerable: true, get: function () { return variables_js_2.VariablePrimitiveSchema; } });
+Object.defineProperty(exports, "VariableValueSchema", { enumerable: true, get: function () { return variables_js_2.VariableValueSchema; } });
+Object.defineProperty(exports, "VariablesSchema", { enumerable: true, get: function () { return variables_js_2.VariablesSchema; } });
 // =============================================================================
 // Shared Components
 // =============================================================================
@@ -61,7 +66,7 @@ exports.ModelConfigObjectSchema = v4_1.z
     }),
     modelName: v4_1.z.string().meta({
         description: "Model name string with provider prefix (e.g., 'openai/gpt-5-nano')",
-        example: "openai/gpt-5-nano",
+        example: "openai/gpt-5.4-mini",
     }),
     apiKey: v4_1.z.string().optional().meta({
         description: "API key for the model provider",
@@ -71,6 +76,9 @@ exports.ModelConfigObjectSchema = v4_1.z
         description: "Base URL for the model provider",
         example: "https://api.openai.com/v1",
     }),
+    headers: v4_1.z.record(v4_1.z.string(), v4_1.z.string()).optional().meta({
+        description: "Custom headers sent with every request to the model provider",
+    }),
 })
     .meta({ id: "ModelConfigObject" });
 /** Model configuration */
@@ -210,12 +218,16 @@ exports.BrowserbaseBrowserSettingsSchema = v4_1.z
     .object({
     advancedStealth: v4_1.z.boolean().optional(),
     blockAds: v4_1.z.boolean().optional(),
+    captchaImageSelector: v4_1.z.string().optional(),
+    captchaInputSelector: v4_1.z.string().optional(),
     context: exports.BrowserbaseContextSchema.optional(),
     extensionId: v4_1.z.string().optional(),
     fingerprint: exports.BrowserbaseFingerprintSchema.optional(),
     logSession: v4_1.z.boolean().optional(),
+    os: v4_1.z.enum(["windows", "mac", "linux", "mobile", "tablet"]).optional(),
     recordSession: v4_1.z.boolean().optional(),
     solveCaptchas: v4_1.z.boolean().optional(),
+    verified: v4_1.z.boolean().optional(),
     viewport: exports.BrowserbaseViewportSchema.optional(),
 })
     .meta({ id: "BrowserbaseBrowserSettings" });
@@ -276,7 +288,7 @@ exports.SessionStartRequestSchema = v4_1.z
     .object({
     modelName: v4_1.z.string().meta({
         description: "Model name to use for AI operations",
-        example: "openai/gpt-4o",
+        example: "openai/gpt-5.4-mini",
     }),
     domSettleTimeoutMs: v4_1.z.number().optional().meta({
         description: "Timeout in ms to wait for DOM to settle",
@@ -364,12 +376,15 @@ exports.ActOptionsSchema = v4_1.z
     model: v4_1.z.union([exports.ModelConfigSchema, v4_1.z.string()]).optional().meta({
         description: "Model configuration object or model name string (e.g., 'openai/gpt-5-nano')",
     }),
-    variables: v4_1.z
-        .record(v4_1.z.string(), v4_1.z.string())
-        .optional()
-        .meta({
-        description: "Variables to substitute in the action instruction",
-        example: { username: "john_doe" },
+    variables: variables_js_1.VariablesSchema.optional().meta({
+        description: "Variables to substitute in the action instruction. Accepts flat primitives or { value, description? } objects.",
+        example: {
+            username: "john_doe",
+            password: {
+                value: "secret123",
+                description: "The login password",
+            },
+        },
     }),
     timeout: v4_1.z.number().optional().meta({
         description: "Timeout in ms for the action",
@@ -483,6 +498,16 @@ exports.ObserveOptionsSchema = v4_1.z
     model: v4_1.z.union([exports.ModelConfigSchema, v4_1.z.string()]).optional().meta({
         description: "Model configuration object or model name string (e.g., 'openai/gpt-5-nano')",
     }),
+    variables: variables_js_1.VariablesSchema.optional().meta({
+        description: "Variables whose names are exposed to the model so observe() returns %variableName% placeholders in suggested action arguments instead of literal values. Accepts flat primitives or { value, description? } objects.",
+        example: {
+            username: {
+                value: "john@example.com",
+                description: "The login email",
+            },
+            rememberMe: true,
+        },
+    }),
     timeout: v4_1.z.number().optional().meta({
         description: "Timeout in ms for the observation",
         example: 30000,
@@ -625,6 +650,14 @@ exports.AgentExecuteOptionsSchema = v4_1.z
         description: "Whether to visually highlight the cursor during execution",
         example: true,
     }),
+    useSearch: v4_1.z.boolean().optional().meta({
+        description: "Whether to enable the web search tool powered by Browserbase Search API",
+        example: true,
+    }),
+    toolTimeout: v4_1.z.number().optional().meta({
+        description: "Timeout in milliseconds for each agent tool call",
+        example: 30000,
+    }),
 })
     .meta({ id: "AgentExecuteOptions" });
 exports.AgentExecuteRequestSchema = v4_1.z
@@ -794,11 +827,9 @@ exports.StreamEventLogDataSchema = v4_1.z
 /**
  * SSE stream event sent during streaming responses.
  *
- * IMPORTANT: Key ordering matters for Stainless SDK generation.
- * The `data` field MUST be serialized first, with `status` as the first key within it.
- * This allows Stainless to use `data_starts_with: '{"data":{"status":"finished"'` for event handling.
- *
- * Expected serialization order: {"data":{"status":...},"type":...,"id":...}
+ * The SSE wire format includes an `event:` line that mirrors the stream status
+ * (`starting`, `connected`, `running`, `finished`, or `error`) followed by a
+ * JSON `data:` line containing the typed payload below.
  */
 exports.StreamEventSchema = v4_1.z
     .object({
@@ -811,7 +842,7 @@ exports.StreamEventSchema = v4_1.z
 })
     .meta({
     id: "StreamEvent",
-    description: "Server-Sent Event emitted during streaming responses. Events are sent as `data: <JSON>\\n\\n`. Key order: data (with status first), type, id.",
+    description: "Server-Sent Event emitted during streaming responses. Events are sent as `event: <status>\\ndata: <JSON>\\n\\n`, where the JSON payload has the shape `{ data, type, id }`.",
 });
 // =============================================================================
 // OpenAPI Components