openai 7.12.1 → 7.14.0

package/src/resources/shared.ts

@@ -257,8 +257,8 @@ export interface FunctionDefinition {
 
   /**
    * The parameters the functions accepts, described as a JSON Schema object. See the
-   * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
-   * and the
+   * [guide](https://developers.openai.com/api/docs/guides/function-calling) for
+   * examples, and the
    * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
    * documentation about the format.
    *
@@ -271,15 +271,15 @@ export interface FunctionDefinition {
    * set to true, the model will follow the exact schema defined in the `parameters`
    * field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
    * more about Structured Outputs in the
-   * [function calling guide](https://platform.openai.com/docs/guides/function-calling).
+   * [function calling guide](https://developers.openai.com/api/docs/guides/function-calling).
    */
   strict?: boolean | null;
 }
 
 /**
  * The parameters the functions accepts, described as a JSON Schema object. See the
- * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
- * and the
+ * [guide](https://developers.openai.com/api/docs/guides/function-calling) for
+ * examples, and the
  * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
  * documentation about the format.
  *
@@ -301,7 +301,7 @@ export type OAuthErrorCode = 'invalid_grant' | 'invalid_subject_token' | (string
 
 /**
  * Configuration options for
- * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+ * [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
  */
 export interface Reasoning {
   /**
@@ -319,7 +319,7 @@ export interface Reasoning {
    * are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
    * reasoning effort can result in faster responses and fewer tokens used on
    * reasoning in a response. Not all reasoning models support every value. See the
-   * [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+   * [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
    * model-specific support.
    */
   effort?: ReasoningEffort | null;
@@ -356,7 +356,7 @@ export interface Reasoning {
  * are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
  * reasoning effort can result in faster responses and fewer tokens used on
  * reasoning in a response. Not all reasoning models support every value. See the
- * [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+ * [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
  * model-specific support.
  */
 export type ReasoningEffort = 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
@@ -376,7 +376,7 @@ export interface ResponseFormatJSONObject {
 /**
  * JSON Schema response format. Used to generate structured JSON responses. Learn
  * more about
- * [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+ * [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
  */
 export interface ResponseFormatJSONSchema {
   /**
@@ -418,7 +418,7 @@ export namespace ResponseFormatJSONSchema {
      * true, the model will always follow the exact schema defined in the `schema`
      * field. Only a subset of JSON Schema is supported when `strict` is `true`. To
      * learn more, read the
-     * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+     * [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
      */
     strict?: boolean | null;
   }
@@ -436,7 +436,7 @@ export interface ResponseFormatText {
 
 /**
  * A custom grammar for the model to follow when generating text. Learn more in the
- * [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars).
+ * [custom grammars guide](https://developers.openai.com/api/docs/guides/function-calling#context-free-grammars).
  */
 export interface ResponseFormatTextGrammar {
   /**
@@ -452,7 +452,7 @@ export interface ResponseFormatTextGrammar {
 
 /**
  * Configure the model to generate valid Python code. See the
- * [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars)
+ * [custom grammars guide](https://developers.openai.com/api/docs/guides/function-calling#context-free-grammars)
  * for more details.
  */
 export interface ResponseFormatTextPython {

package/src/resources/uploads/parts.ts

@@ -13,16 +13,17 @@ import { path } from '../../internal/utils/path';
 export class Parts extends APIResource {
   /**
    * Adds a
-   * [Part](https://platform.openai.com/docs/api-reference/uploads/part-object) to an
-   * [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object.
-   * A Part represents a chunk of bytes from the file you are trying to upload.
+   * [Part](https://developers.openai.com/api/reference/resources/uploads/subresources/parts)
+   * to an [Upload](https://developers.openai.com/api/reference/resources/uploads)
+   * object. A Part represents a chunk of bytes from the file you are trying to
+   * upload.
    *
    * Each Part can be at most 64 MB, and you can add Parts until you hit the Upload
    * maximum of 8 GB.
    *
    * It is possible to add multiple Parts in parallel. You can decide the intended
    * order of the Parts when you
-   * [complete the Upload](https://platform.openai.com/docs/api-reference/uploads/complete).
+   * [complete the Upload](https://developers.openai.com/api/reference/resources/uploads/methods/complete).
    */
   create(uploadID: string, body: PartCreateParams, options?: RequestOptions): APIPromise<UploadPart> {
     return this._client.post(

package/src/resources/uploads/uploads.ts

@@ -16,24 +16,24 @@ export class Uploads extends APIResource {
 
   /**
    * Creates an intermediate
-   * [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object
+   * [Upload](https://developers.openai.com/api/reference/resources/uploads) object
    * that you can add
-   * [Parts](https://platform.openai.com/docs/api-reference/uploads/part-object) to.
-   * Currently, an Upload can accept at most 8 GB in total and expires after an hour
-   * after you create it.
+   * [Parts](https://developers.openai.com/api/reference/resources/uploads/subresources/parts)
+   * to. Currently, an Upload can accept at most 8 GB in total and expires after an
+   * hour after you create it.
    *
    * Once you complete the Upload, we will create a
-   * [File](https://platform.openai.com/docs/api-reference/files/object) object that
+   * [File](https://developers.openai.com/api/reference/resources/files) object that
    * contains all the parts you uploaded. This File is usable in the rest of our
    * platform as a regular File object.
    *
    * For certain `purpose` values, the correct `mime_type` must be specified. Please
    * refer to documentation for the
-   * [supported MIME types for your use case](https://platform.openai.com/docs/assistants/tools/file-search#supported-files).
+   * [supported MIME types for your use case](https://developers.openai.com/api/docs/guides/tools-file-search#supported-files).
    *
    * For guidance on the proper filename extensions for each purpose, please follow
    * the documentation on
-   * [creating a File](https://platform.openai.com/docs/api-reference/files/create).
+   * [creating a File](https://developers.openai.com/api/reference/resources/files/methods/create).
    *
    * Returns the Upload object with status `pending`.
    */
@@ -55,10 +55,10 @@ export class Uploads extends APIResource {
 
   /**
    * Completes the
-   * [Upload](https://platform.openai.com/docs/api-reference/uploads/object).
+   * [Upload](https://developers.openai.com/api/reference/resources/uploads).
    *
    * Within the returned Upload object, there is a nested
-   * [File](https://platform.openai.com/docs/api-reference/files/object) object that
+   * [File](https://developers.openai.com/api/reference/resources/files) object that
    * is ready to use in the rest of the platform.
    *
    * You can specify the order of the Parts by passing in an ordered list of the Part
@@ -115,7 +115,7 @@ export interface Upload {
 
   /**
    * The intended purpose of the file.
-   * [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose)
+   * [Please refer here](https://developers.openai.com/api/reference/resources/files#%28resource%29%20files%20%3E%20%28model%29%20file_object%20%3E%20%28schema%29%20%3E%20%28property%29%20purpose)
    * for acceptable values.
    */
   purpose: string;
@@ -154,7 +154,7 @@ export interface UploadCreateParams {
    * The intended purpose of the uploaded file.
    *
    * See the
-   * [documentation on File purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose).
+   * [documentation on File purposes](https://developers.openai.com/api/reference/resources/files/methods/create#%28resource%29%20files%20%3E%20%28method%29%20create%20%3E%20%28params%29%200%20%3E%20%28param%29%20purpose%20%3E%20%28schema%29).
    */
   purpose: FilesAPI.FilePurpose;
 

package/src/resources/vector-stores/file-batches.ts

@@ -161,8 +161,8 @@ export interface VectorStoreFileBatch {
 
   /**
    * The ID of the
-   * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
-   * that the [File](https://platform.openai.com/docs/api-reference/files) is
+   * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+   * that the [File](https://developers.openai.com/api/reference/resources/files) is
    * attached to.
    */
   vector_store_id: string;
@@ -214,12 +214,12 @@ export interface FileBatchCreateParams {
   chunking_strategy?: VectorStoresAPI.FileChunkingStrategyParam;
 
   /**
-   * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-   * the vector store should use. Useful for tools like `file_search` that can access
-   * files. If `attributes` or `chunking_strategy` are provided, they will be applied
-   * to all files in the batch. The maximum batch size is 2000 files. This endpoint
-   * is recommended for multi-file ingestion and helps reduce per-vector-store write
-   * request pressure. Mutually exclusive with `files`.
+   * A list of [File](https://developers.openai.com/api/reference/resources/files)
+   * IDs that the vector store should use. Useful for tools like `file_search` that
+   * can access files. If `attributes` or `chunking_strategy` are provided, they will
+   * be applied to all files in the batch. The maximum batch size is 2000 files. This
+   * endpoint is recommended for multi-file ingestion and helps reduce
+   * per-vector-store write request pressure. Mutually exclusive with `files`.
    */
   file_ids?: Array<string>;
 
@@ -237,10 +237,10 @@ export interface FileBatchCreateParams {
 export namespace FileBatchCreateParams {
   export interface File {
     /**
-     * A [File](https://platform.openai.com/docs/api-reference/files) ID that the
-     * vector store should use. Useful for tools like `file_search` that can access
+     * A [File](https://developers.openai.com/api/reference/resources/files) ID that
+     * the vector store should use. Useful for tools like `file_search` that can access
      * files. For multi-file ingestion, we recommend
-     * [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+     * [`file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create)
      * to minimize per-vector-store write requests.
      */
     file_id: string;

package/src/resources/vector-stores/files.ts

@@ -13,8 +13,8 @@ import { path } from '../../internal/utils/path';
 export class Files extends APIResource {
   /**
    * Create a vector store file by attaching a
-   * [File](https://platform.openai.com/docs/api-reference/files) to a
-   * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object).
+   * [File](https://developers.openai.com/api/reference/resources/files) to a
+   * [vector store](https://developers.openai.com/api/reference/resources/vector_stores).
    */
   create(
     vectorStoreID: string,
@@ -77,7 +77,7 @@ export class Files extends APIResource {
   /**
    * Delete a vector store file. This will remove the file from the vector store but
    * the file itself will not be deleted. To delete the file, use the
-   * [delete file](https://platform.openai.com/docs/api-reference/files/delete)
+   * [delete file](https://developers.openai.com/api/reference/resources/files/methods/delete)
    * endpoint.
    */
   delete(
@@ -205,8 +205,8 @@ export interface VectorStoreFile {
 
   /**
    * The ID of the
-   * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
-   * that the [File](https://platform.openai.com/docs/api-reference/files) is
+   * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
+   * that the [File](https://developers.openai.com/api/reference/resources/files) is
    * attached to.
    */
   vector_store_id: string;
@@ -266,10 +266,10 @@ export interface FileContentResponse {
 
 export interface FileCreateParams {
   /**
-   * A [File](https://platform.openai.com/docs/api-reference/files) ID that the
-   * vector store should use. Useful for tools like `file_search` that can access
+   * A [File](https://developers.openai.com/api/reference/resources/files) ID that
+   * the vector store should use. Useful for tools like `file_search` that can access
    * files. For multi-file ingestion, we recommend
-   * [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+   * [`file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create)
    * to minimize per-vector-store write requests.
    */
   file_id: string;

package/src/resources/vector-stores/vector-stores.ts

@@ -381,9 +381,9 @@ export interface VectorStoreCreateParams {
   expires_after?: VectorStoreCreateParams.ExpiresAfter;
 
   /**
-   * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-   * the vector store should use. Useful for tools like `file_search` that can access
-   * files.
+   * A list of [File](https://developers.openai.com/api/reference/resources/files)
+   * IDs that the vector store should use. Useful for tools like `file_search` that
+   * can access files.
    */
   file_ids?: Array<string>;
 

package/src/resources/webhooks/api.md

@@ -13,6 +13,7 @@ Types:
 - <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>

package/src/resources/webhooks/webhooks.ts

@@ -501,6 +501,8 @@ export namespace FineTuningJobSucceededWebhookEvent {
 }
 
 /**
+ * @deprecated Deprecated: use `live.transport.incoming`. Retained for existing
+ * subscriptions during migration; new subscriptions to this event are not allowed.
  * Sent when an incoming API SIP session is available for Live acceptance. The same
  * pending session can also emit `realtime.call.incoming`; the first successful
  * Realtime or Live accept endpoint selects the runtime surface.
@@ -533,6 +535,76 @@ export interface LiveCallIncomingWebhookEvent {
 }
 
 export namespace LiveCallIncomingWebhookEvent {
+  /**
+   * Event data payload.
+   */
+  export interface Data {
+    /**
+     * The `live_...` ID of the pending SIP session. Pass this value unchanged to Live
+     * call controls and sideband connections. The corresponding
+     * `realtime.call.incoming` event uses a separate `rtc_...` call ID.
+     */
+    session_id: string;
+
+    /**
+     * Headers from the SIP INVITE, excluding SIP authorization headers. Retained
+     * names, values, repeated entries, and order are preserved. Treat these values as
+     * untrusted call metadata.
+     */
+    sip_headers: Array<Data.SipHeader>;
+  }
+
+  export namespace Data {
+    /**
+     * A header from the SIP Invite.
+     */
+    export interface SipHeader {
+      /**
+       * Name of the SIP Header.
+       */
+      name: string;
+
+      /**
+       * Value of the SIP Header.
+       */
+      value: string;
+    }
+  }
+}
+
+/**
+ * Sent when an incoming API SIP session is available for Live acceptance. The same
+ * pending session can also emit `realtime.call.incoming`; the first successful
+ * Realtime or Live accept endpoint selects the runtime surface.
+ */
+export interface LiveTransportIncomingWebhookEvent {
+  /**
+   * The unique ID of the event.
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) of when the event was created.
+   */
+  created_at: number;
+
+  /**
+   * Event data payload.
+   */
+  data: LiveTransportIncomingWebhookEvent.Data;
+
+  /**
+   * The type of the event. Always `live.transport.incoming`.
+   */
+  type: 'live.transport.incoming';
+
+  /**
+   * The object of the event. Always `event`.
+   */
+  object?: 'event';
+}
+
+export namespace LiveTransportIncomingWebhookEvent {
   /**
    * Event data payload.
    */
@@ -544,9 +616,16 @@ export namespace LiveCallIncomingWebhookEvent {
     session_id: string;
 
     /**
-     * Headers from the SIP Invite.
+     * Headers from the SIP INVITE, excluding SIP authorization headers. Retained
+     * names, values, repeated entries, and order are preserved. Treat these values as
+     * untrusted call metadata.
      */
     sip_headers: Array<Data.SipHeader>;
+
+    /**
+     * The incoming transport type. Always `sip`.
+     */
+    type: 'sip';
   }
 
   export namespace Data {
@@ -569,8 +648,8 @@ export namespace LiveCallIncomingWebhookEvent {
 
 /**
  * Sent when an incoming API SIP session is available for Realtime acceptance. The
- * same pending session can also emit `live.call.incoming`; the first successful
- * Realtime or Live accept endpoint selects the runtime surface.
+ * same pending session can also emit `live.transport.incoming`; the first
+ * successful Realtime or Live accept endpoint selects the runtime surface.
  */
 export interface RealtimeCallIncomingWebhookEvent {
   /**
@@ -606,14 +685,16 @@ export namespace RealtimeCallIncomingWebhookEvent {
   export interface Data {
     /**
      * The Transceiver `rtc_...` ID of the pending SIP session. The paired
-     * `live.call.incoming` event derives its `session_id` by replacing the `rtc_`
+     * `live.transport.incoming` event derives its `session_id` by replacing the `rtc_`
      * prefix with `live_`. Use the ID returned by the event with the corresponding
      * Realtime or Live API.
      */
     call_id: string;
 
     /**
-     * Headers from the SIP Invite.
+     * Headers from the SIP INVITE, excluding SIP authorization headers. Retained
+     * names, values, repeated entries, and order are preserved. Treat these values as
+     * untrusted call metadata.
      */
     sip_headers: Array<Data.SipHeader>;
   }
@@ -891,6 +972,7 @@ export type UnwrapWebhookEvent =
   | FineTuningJobFailedWebhookEvent
   | FineTuningJobSucceededWebhookEvent
   | LiveCallIncomingWebhookEvent
+  | LiveTransportIncomingWebhookEvent
   | RealtimeCallIncomingWebhookEvent
   | ResponseCancelledWebhookEvent
   | ResponseCompletedWebhookEvent
@@ -912,6 +994,7 @@ export declare namespace Webhooks {
     type FineTuningJobFailedWebhookEvent as FineTuningJobFailedWebhookEvent,
     type FineTuningJobSucceededWebhookEvent as FineTuningJobSucceededWebhookEvent,
     type LiveCallIncomingWebhookEvent as LiveCallIncomingWebhookEvent,
+    type LiveTransportIncomingWebhookEvent as LiveTransportIncomingWebhookEvent,
     type RealtimeCallIncomingWebhookEvent as RealtimeCallIncomingWebhookEvent,
     type ResponseCancelledWebhookEvent as ResponseCancelledWebhookEvent,
     type ResponseCompletedWebhookEvent as ResponseCompletedWebhookEvent,

package/src/version.ts

@@ -1,2 +1,2 @@
 /** Version of the installed OpenAI SDK package. */
-export const VERSION = '7.12.1'; // x-release-please-version
+export const VERSION = '7.14.0'; // x-release-please-version

package/version.d.mts

@@ -1,3 +1,3 @@
 /** Version of the installed OpenAI SDK package. */
-export declare const VERSION = "7.12.1";
+export declare const VERSION = "7.14.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,3 +1,3 @@
 /** Version of the installed OpenAI SDK package. */
-export declare const VERSION = "7.12.1";
+export declare const VERSION = "7.14.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 /** Version of the installed OpenAI SDK package. */
-exports.VERSION = '7.12.1'; // x-release-please-version
+exports.VERSION = '7.14.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,3 +1,3 @@
 /** Version of the installed OpenAI SDK package. */
-export const VERSION = '7.12.1'; // x-release-please-version
+export const VERSION = '7.14.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map