openai 7.17.0 → 7.19.0

package/src/resources/beta/responses/ws.ts

@@ -4,7 +4,6 @@ import * as WS from 'ws';
 import { NodeWebSocket } from '../../../internal/ws-adapter-node';
 import { ResponsesWSBase, type ResponsesWSBaseOptions } from './ws-base';
 import { OpenAI } from '../../../client';
-import { VERSION } from '../../../version';
 import { OpenAIError } from '../../../core/error';
 import { snapshotWebSocketCredentials } from '../../../internal/ws';
 
@@ -34,13 +33,17 @@ export class ResponsesWS extends ResponsesWSBase<NodeWebSocket> {
 
   protected _createSocket(url: URL, authHeaders: Record<string, string>): NodeWebSocket {
     const capturedAuthHeaders = { ...authHeaders };
+    const headers = new Map(Object.entries(this._client._buildWebSocketHeaders(capturedAuthHeaders)));
+    for (const [name, value] of Object.entries(this._wsOptions?.headers ?? {})) {
+      if (value === null) {
+        headers.delete(name.toLowerCase());
+      } else if (value !== undefined) {
+        headers.set(name.toLowerCase(), value);
+      }
+    }
     const socketOptions: ResponsesWSClientOptions = {
       ...this._wsOptions,
-      headers: {
-        'User-Agent': `${this._client.constructor.name}/JS ${VERSION}`,
-        ...capturedAuthHeaders,
-        ...this._wsOptions?.headers,
-      },
+      headers: Object.fromEntries(headers),
       followRedirects: false,
     };
     if (

package/src/resources/index.ts

@@ -156,4 +156,4 @@ export {
   type VideoRemixParams,
   type VideosPage,
 } from './videos';
-export { Webhooks } from './webhooks';
+export { Webhooks } from './webhooks/webhooks';

package/src/resources/live/forks/ws.ts

@@ -4,7 +4,6 @@ import * as WS from 'ws';
 import { NodeWebSocket } from '../../../internal/ws-adapter-node';
 import { ForksWSBase, type ForksWSBaseOptions, type ForksWSParameters } from './ws-base';
 import { OpenAI } from '../../../client';
-import { VERSION } from '../../../version';
 
 export type { WebSocketStreamOptions } from '../../../internal/ws';
 
@@ -36,10 +35,10 @@ export class ForksWS extends ForksWSBase<NodeWebSocket> {
     const ws = new WS.WebSocket(url, {
       ...this._wsOptions,
       headers: {
-        'User-Agent': `${this._client.constructor.name}/JS ${VERSION}`,
-
-        ...authHeaders,
-        ...this._wsOptions?.headers,
+        ...this._client._buildWebSocketHeaders(authHeaders),
+        ...Object.fromEntries(
+          Object.entries(this._wsOptions?.headers ?? {}).map(([name, value]) => [name.toLowerCase(), value]),
+        ),
       },
       followRedirects: false,
     });

package/src/resources/live/sideband/ws.ts

@@ -4,7 +4,6 @@ import * as WS from 'ws';
 import { NodeWebSocket } from '../../../internal/ws-adapter-node';
 import { SidebandWSBase, type SidebandWSBaseOptions, type SidebandWSParameters } from './ws-base';
 import { OpenAI } from '../../../client';
-import { VERSION } from '../../../version';
 
 export type { WebSocketStreamOptions } from '../../../internal/ws';
 
@@ -36,10 +35,10 @@ export class SidebandWS extends SidebandWSBase<NodeWebSocket> {
     const ws = new WS.WebSocket(url, {
       ...this._wsOptions,
       headers: {
-        'User-Agent': `${this._client.constructor.name}/JS ${VERSION}`,
-
-        ...authHeaders,
-        ...this._wsOptions?.headers,
+        ...this._client._buildWebSocketHeaders(authHeaders),
+        ...Object.fromEntries(
+          Object.entries(this._wsOptions?.headers ?? {}).map(([name, value]) => [name.toLowerCase(), value]),
+        ),
       },
       followRedirects: false,
     });

package/src/resources/live/ws.ts

@@ -4,7 +4,6 @@ import * as WS from 'ws';
 import { NodeWebSocket } from '../../internal/ws-adapter-node';
 import { LiveWSBase, type LiveWSBaseOptions } from './ws-base';
 import { OpenAI } from '../../client';
-import { VERSION } from '../../version';
 
 export type { WebSocketStreamOptions } from '../../internal/ws';
 
@@ -32,10 +31,10 @@ export class LiveWS extends LiveWSBase<NodeWebSocket> {
     const ws = new WS.WebSocket(url, {
       ...this._wsOptions,
       headers: {
-        'User-Agent': `${this._client.constructor.name}/JS ${VERSION}`,
-
-        ...authHeaders,
-        ...this._wsOptions?.headers,
+        ...this._client._buildWebSocketHeaders(authHeaders),
+        ...Object.fromEntries(
+          Object.entries(this._wsOptions?.headers ?? {}).map(([name, value]) => [name.toLowerCase(), value]),
+        ),
       },
       followRedirects: false,
     });

package/src/resources/realtime/client-secrets.ts

@@ -427,11 +427,15 @@ export namespace RealtimeSessionCreateResponse {
     authorization?: string;
 
     /**
-     * Identifier for service connectors, like those available in ChatGPT. One of
-     * `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
-     * service connectors
+     * @deprecated Identifier for service connectors, like those available in ChatGPT.
+     * One of `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more
+     * about service connectors
      * [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
      *
+     * This field is deprecated for models released after September 1, 2026. Use
+     * `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+     * through a Secure MCP Tunnel.
+     *
      * Currently supported `connector_id` values are:
      *
      * - Dropbox: `connector_dropbox`

package/src/resources/realtime/realtime.ts

@@ -175,8 +175,9 @@ export interface ConversationItemAdded {
  * "history" of the conversation and to add new items mid-stream, but has the
  * current limitation that it cannot populate assistant audio messages.
  *
- * If successful, the server will respond with a `conversation.item.created` event,
- * otherwise an `error` event will be sent.
+ * If successful, the server will emit a `conversation.item.added` event and, when
+ * the item is finalized, a `conversation.item.done` event. Otherwise, an `error`
+ * event will be sent.
  */
 export interface ConversationItemCreateEvent {
   /**
@@ -2263,11 +2264,15 @@ export interface RealtimeResponseCreateMcpTool {
   authorization?: string;
 
   /**
-   * Identifier for service connectors, like those available in ChatGPT. One of
-   * `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
-   * service connectors
+   * @deprecated Identifier for service connectors, like those available in ChatGPT.
+   * One of `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more
+   * about service connectors
    * [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
    *
+   * This field is deprecated for models released after September 1, 2026. Use
+   * `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+   * through a Secure MCP Tunnel.
+   *
    * Currently supported `connector_id` values are:
    *
    * - Dropbox: `connector_dropbox`
@@ -3317,11 +3322,15 @@ export namespace RealtimeToolsConfigUnion {
     authorization?: string;
 
     /**
-     * Identifier for service connectors, like those available in ChatGPT. One of
-     * `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
-     * service connectors
+     * @deprecated Identifier for service connectors, like those available in ChatGPT.
+     * One of `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more
+     * about service connectors
      * [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
      *
+     * This field is deprecated for models released after September 1, 2026. Use
+     * `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+     * through a Secure MCP Tunnel.
+     *
      * Currently supported `connector_id` values are:
      *
      * - Dropbox: `connector_dropbox`

package/src/resources/responses/responses.ts

@@ -9110,6 +9110,12 @@ export namespace ResponsesClientEvent {
        */
       mode?: 'implicit' | 'explicit';
 
+      /**
+       * Prepares the prompt cache without generating output. Defaults to `false`. When
+       * set to `true`, overrides the `generate` field to `false`.
+       */
+      prewarm?: boolean;
+
       /**
        * The minimum lifetime applied to every implicit and explicit cache breakpoint
        * written by the request. Defaults to `30m`, which is currently the only supported
@@ -10074,11 +10080,15 @@ export namespace Tool {
     authorization?: string;
 
     /**
-     * Identifier for service connectors, like those available in ChatGPT. One of
-     * `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
-     * service connectors
+     * @deprecated Identifier for service connectors, like those available in ChatGPT.
+     * One of `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more
+     * about service connectors
      * [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
      *
+     * This field is deprecated for models released after September 1, 2026. Use
+     * `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+     * through a Secure MCP Tunnel.
+     *
      * Currently supported `connector_id` values are:
      *
      * - Dropbox: `connector_dropbox`
@@ -11133,6 +11143,12 @@ export namespace ResponseCreateParams {
      */
     mode?: 'implicit' | 'explicit';
 
+    /**
+     * Prepares the prompt cache without generating output. Defaults to `false`. When
+     * set to `true`, overrides the `generate` field to `false`.
+     */
+    prewarm?: boolean;
+
     /**
      * The minimum lifetime applied to every implicit and explicit cache breakpoint
      * written by the request. Defaults to `30m`, which is currently the only supported
@@ -11315,6 +11331,8 @@ export interface ResponseCompactParams {
     | 'gpt-4o-2024-11-20'
     | 'gpt-4o-2024-08-06'
     | 'gpt-4o-2024-05-13'
+    | 'gpt-audio-mini'
+    | 'gpt-audio-mini-2025-12-15'
     | 'gpt-4o-audio-preview'
     | 'gpt-4o-audio-preview-2024-10-01'
     | 'gpt-4o-audio-preview-2024-12-17'

package/src/resources/responses/ws-base.ts

@@ -7,6 +7,8 @@ import { type WebSocketLike, ReadyState } from '../../internal/ws-adapter';
 import {
   SendQueue,
   getMaxBufferedEvents,
+  recordWebSocketError,
+  rawByteLength,
   type WebSocketStreamOptions,
   flattenRawData,
   isRecoverableClose,
@@ -19,6 +21,21 @@ import * as ResponsesAPI from './responses';
 import { OpenAI } from '../../client';
 import { OpenAIError } from '../../core/error';
 
+const webSocketEventPayloads = new WeakMap<ResponsesAPI.ResponsesServerEvent, string>();
+const webSocketEventBytes = new WeakMap<ResponsesAPI.ResponsesServerEvent, number>();
+
+/** Uses immutable wire size, or JSON accounting for a custom emitter. @internal */
+export function getWebSocketEventBytes(event: ResponsesAPI.ResponsesServerEvent): number {
+  return webSocketEventBytes.get(event) ?? rawByteLength(JSON.stringify(event));
+}
+
+/** Original JSON, available only during synchronous event notification.
+ * @internal
+ */
+export function getWebSocketEventPayload(event: ResponsesAPI.ResponsesServerEvent): string | undefined {
+  return webSocketEventPayloads.get(event);
+}
+
 export interface ResponsesWSReconnectOptions {
   /**
    * Called before each reconnect attempt. Return an object with
@@ -440,6 +457,7 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
       }
 
       const eventType: string = event.type;
+      const errorEvent = event.type === 'error' ? event : undefined;
       const reservedEventType =
         eventType === 'raw' ||
         eventType === 'close' ||
@@ -453,17 +471,24 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
         return;
       }
 
-      this._emit('event', event);
+      webSocketEventBytes.set(event, rawByteLength(data));
+      webSocketEventPayloads.set(event, text);
+      try {
+        this._emit('event', event);
+      } finally {
+        webSocketEventPayloads.delete(event);
+      }
 
-      if (event.type === 'error') {
-        this._onError(event);
+      if (errorEvent) {
+        this._onError(errorEvent);
       } else {
         // @ts-ignore TS isn't smart enough to get the relationship right here
-        this._emit(event.type, event);
+        this._emit(eventType, event);
       }
     });
 
     socket.on('error', (err: Error) => {
+      recordWebSocketError(socket, err);
       // Suppress transient errors during reconnection — the retry loop
       // already handles them and will surface a close if retries exhaust.
       if (this._isReconnecting) return;

package/src/resources/responses/ws.ts

@@ -4,7 +4,6 @@ import * as WS from 'ws';
 import { NodeWebSocket } from '../../internal/ws-adapter-node';
 import { ResponsesWSBase, type ResponsesWSBaseOptions } from './ws-base';
 import { OpenAI } from '../../client';
-import { VERSION } from '../../version';
 import { OpenAIError } from '../../core/error';
 import { snapshotWebSocketCredentials } from '../../internal/ws';
 
@@ -34,13 +33,17 @@ export class ResponsesWS extends ResponsesWSBase<NodeWebSocket> {
 
   protected _createSocket(url: URL, authHeaders: Record<string, string>): NodeWebSocket {
     const capturedAuthHeaders = { ...authHeaders };
+    const headers = new Map(Object.entries(this._client._buildWebSocketHeaders(capturedAuthHeaders)));
+    for (const [name, value] of Object.entries(this._wsOptions?.headers ?? {})) {
+      if (value === null) {
+        headers.delete(name.toLowerCase());
+      } else if (value !== undefined) {
+        headers.set(name.toLowerCase(), value);
+      }
+    }
     const socketOptions: ResponsesWSClientOptions = {
       ...this._wsOptions,
-      headers: {
-        'User-Agent': `${this._client.constructor.name}/JS ${VERSION}`,
-        ...capturedAuthHeaders,
-        ...this._wsOptions?.headers,
-      },
+      headers: Object.fromEntries(headers),
       followRedirects: false,
     };
     if (

package/src/resources/shared.ts

@@ -75,6 +75,8 @@ export type ChatModel =
   | 'gpt-4o-2024-11-20'
   | 'gpt-4o-2024-08-06'
   | 'gpt-4o-2024-05-13'
+  | 'gpt-audio-mini'
+  | 'gpt-audio-mini-2025-12-15'
   | 'gpt-4o-audio-preview'
   | 'gpt-4o-audio-preview-2024-10-01'
   | 'gpt-4o-audio-preview-2024-12-17'

package/src/resources/webhooks/api.md

@@ -2,27 +2,46 @@
 
 Types:
 
-- <code><a href="./src/resources/webhooks.ts">BatchCancelledWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">BatchCompletedWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">BatchExpiredWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">BatchFailedWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">EvalRunCanceledWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">EvalRunFailedWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">EvalRunSucceededWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">FineTuningJobCancelledWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">FineTuningJobFailedWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">FineTuningJobSucceededWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">LiveCallIncomingWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">LiveTransportIncomingWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">RealtimeCallIncomingWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">ResponseCancelledWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">ResponseCompletedWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">ResponseFailedWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">ResponseIncompleteWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">SafetyAlertCreatedWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">SafetyOrgAlertCreatedWebhookEvent</a></code>
-- <code><a href="./src/resources/webhooks.ts">UnwrapWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">BatchCancelledWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">BatchCompletedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">BatchExpiredWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">BatchFailedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">DeletedWebhookEndpoint</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">EvalRunCanceledWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">EvalRunFailedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">EvalRunSucceededWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">FineTuningJobCancelledWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">FineTuningJobFailedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">FineTuningJobSucceededWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">LiveCallIncomingWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">LiveTransportIncomingWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">RealtimeCallIncomingWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">ResponseCancelledWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">ResponseCompletedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">ResponseFailedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">ResponseIncompleteWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">SafetyAlertCreatedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">SafetyOrgAlertCreatedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">UnwrapWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">WebhookEndpoint</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">WebhookEndpointList</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">WebhookEndpointTestResult</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">WebhookEndpointWithSecret</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">WebhookEventTypeList</a></code>
 
 Methods:
 
-- <code>client.webhooks.<a href="./src/resources/webhooks.ts">unwrap</a>(body) -> void</code>
+- <code title="post /webhook_endpoints">client.webhooks.<a href="./src/resources/webhooks/webhooks.ts">create</a>({ ...params }) -> WebhookEndpointWithSecret</code>
+- <code title="get /webhook_endpoints/{webhook_endpoint_id}">client.webhooks.<a href="./src/resources/webhooks/webhooks.ts">retrieve</a>(webhookEndpointID) -> WebhookEndpoint</code>
+- <code title="post /webhook_endpoints/{webhook_endpoint_id}">client.webhooks.<a href="./src/resources/webhooks/webhooks.ts">update</a>(webhookEndpointID, { ...params }) -> WebhookEndpoint</code>
+- <code title="get /webhook_endpoints">client.webhooks.<a href="./src/resources/webhooks/webhooks.ts">list</a>({ ...params }) -> WebhookEndpointsPage</code>
+- <code title="delete /webhook_endpoints/{webhook_endpoint_id}">client.webhooks.<a href="./src/resources/webhooks/webhooks.ts">delete</a>(webhookEndpointID) -> DeletedWebhookEndpoint</code>
+- <code title="post /webhook_endpoints/{webhook_endpoint_id}/rotate_secret">client.webhooks.<a href="./src/resources/webhooks/webhooks.ts">rotateSecret</a>(webhookEndpointID, { ...params }) -> WebhookEndpointWithSecret</code>
+- <code title="post /webhook_endpoints/{webhook_endpoint_id}/test">client.webhooks.<a href="./src/resources/webhooks/webhooks.ts">test</a>(webhookEndpointID, { ...params }) -> WebhookEndpointTestResult</code>
+- <code>client.webhooks.<a href="./src/resources/webhooks/webhooks.ts">unwrap</a>(body) -> void</code>
+
+## EventTypes
+
+Methods:
+
+- <code title="get /webhook_event_types">client.webhooks.eventTypes.<a href="./src/resources/webhooks/event-types.ts">list</a>() -> WebhookEventTypeList</code>

package/src/resources/webhooks/event-types.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as WebhooksAPI from './webhooks';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class EventTypes extends APIResource {
+  /**
+   * Returns webhook event types visible to the authenticated project.
+   *
+   * @example
+   * ```ts
+   * const webhookEventTypeList =
+   *   await client.webhooks.eventTypes.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<WebhooksAPI.WebhookEventTypeList> {
+    return this._client.get('/webhook_event_types', { ...options, __security: { bearerAuth: true } });
+  }
+}

package/src/resources/webhooks/index.ts

@@ -1,3 +1,4 @@
 // File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
 
+export { EventTypes } from './event-types';
 export * from './webhooks';