@nocobase/plugin-ai 2.1.6 → 2.1.8

package/dist/node_modules/openai/resources/fine-tuning/checkpoints/permissions.d.ts

@@ -1,7 +1,10 @@
 import { APIResource } from "../../../core/resource.js";
 import { APIPromise } from "../../../core/api-promise.js";
-import { Page, PagePromise } from "../../../core/pagination.js";
+import { ConversationCursorPage, type ConversationCursorPageParams, Page, PagePromise } from "../../../core/pagination.js";
 import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export declare class Permissions extends APIResource {
     /**
      * **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
@@ -21,6 +24,15 @@ export declare class Permissions extends APIResource {
      * ```
      */
     create(fineTunedModelCheckpoint: string, body: PermissionCreateParams, options?: RequestOptions): PagePromise<PermissionCreateResponsesPage, PermissionCreateResponse>;
+    /**
+     * **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
+     *
+     * Organization owners can use this endpoint to view all permissions for a
+     * fine-tuned model checkpoint.
+     *
+     * @deprecated Retrieve is deprecated. Please swap to the paginated list method instead.
+     */
+    retrieve(fineTunedModelCheckpoint: string, query?: PermissionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PermissionRetrieveResponse>;
     /**
      * **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
      *
@@ -29,13 +41,15 @@ export declare class Permissions extends APIResource {
      *
      * @example
      * ```ts
-     * const permission =
-     *   await client.fineTuning.checkpoints.permissions.retrieve(
-     *     'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
-     *   );
+     * // Automatically fetches more pages as needed.
+     * for await (const permissionListResponse of client.fineTuning.checkpoints.permissions.list(
+     *   'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
+     * )) {
+     *   // ...
+     * }
      * ```
      */
-    retrieve(fineTunedModelCheckpoint: string, query?: PermissionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PermissionRetrieveResponse>;
+    list(fineTunedModelCheckpoint: string, query?: PermissionListParams | null | undefined, options?: RequestOptions): PagePromise<PermissionListResponsesPage, PermissionListResponse>;
     /**
      * **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
      *
@@ -57,6 +71,7 @@ export declare class Permissions extends APIResource {
     delete(permissionID: string, params: PermissionDeleteParams, options?: RequestOptions): APIPromise<PermissionDeleteResponse>;
 }
 export type PermissionCreateResponsesPage = Page<PermissionCreateResponse>;
+export type PermissionListResponsesPage = ConversationCursorPage<PermissionListResponse>;
 /**
  * The `checkpoint.permission` object represents a permission for a fine-tuned
  * model checkpoint.
@@ -110,6 +125,28 @@ export declare namespace PermissionRetrieveResponse {
         project_id: string;
     }
 }
+/**
+ * The `checkpoint.permission` object represents a permission for a fine-tuned
+ * model checkpoint.
+ */
+export interface PermissionListResponse {
+    /**
+     * The permission identifier, which can be referenced in the API endpoints.
+     */
+    id: string;
+    /**
+     * The Unix timestamp (in seconds) for when the permission was created.
+     */
+    created_at: number;
+    /**
+     * The object type, which is always "checkpoint.permission".
+     */
+    object: 'checkpoint.permission';
+    /**
+     * The project identifier that the permission is for.
+     */
+    project_id: string;
+}
 export interface PermissionDeleteResponse {
     /**
      * The ID of the fine-tuned model checkpoint permission that was deleted.
@@ -148,6 +185,16 @@ export interface PermissionRetrieveParams {
      */
     project_id?: string;
 }
+export interface PermissionListParams extends ConversationCursorPageParams {
+    /**
+     * The order in which to retrieve permissions.
+     */
+    order?: 'ascending' | 'descending';
+    /**
+     * The ID of the project to get permissions for.
+     */
+    project_id?: string;
+}
 export interface PermissionDeleteParams {
     /**
      * The ID of the fine-tuned model checkpoint to delete a permission for.
@@ -155,6 +202,6 @@ export interface PermissionDeleteParams {
     fine_tuned_model_checkpoint: string;
 }
 export declare namespace Permissions {
-    export { type PermissionCreateResponse as PermissionCreateResponse, type PermissionRetrieveResponse as PermissionRetrieveResponse, type PermissionDeleteResponse as PermissionDeleteResponse, type PermissionCreateResponsesPage as PermissionCreateResponsesPage, type PermissionCreateParams as PermissionCreateParams, type PermissionRetrieveParams as PermissionRetrieveParams, type PermissionDeleteParams as PermissionDeleteParams, };
+    export { type PermissionCreateResponse as PermissionCreateResponse, type PermissionRetrieveResponse as PermissionRetrieveResponse, type PermissionListResponse as PermissionListResponse, type PermissionDeleteResponse as PermissionDeleteResponse, type PermissionCreateResponsesPage as PermissionCreateResponsesPage, type PermissionListResponsesPage as PermissionListResponsesPage, type PermissionCreateParams as PermissionCreateParams, type PermissionRetrieveParams as PermissionRetrieveParams, type PermissionListParams as PermissionListParams, type PermissionDeleteParams as PermissionDeleteParams, };
 }
 //# sourceMappingURL=permissions.d.ts.map

package/dist/node_modules/openai/resources/fine-tuning/checkpoints/permissions.js

@@ -5,6 +5,9 @@ exports.Permissions = void 0;
 const resource_1 = require("../../../core/resource.js");
 const pagination_1 = require("../../../core/pagination.js");
 const path_1 = require("../../../internal/utils/path.js");
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 class Permissions extends resource_1.APIResource {
     /**
      * **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
@@ -24,7 +27,7 @@ class Permissions extends resource_1.APIResource {
      * ```
      */
     create(fineTunedModelCheckpoint, body, options) {
-        return this._client.getAPIList((0, path_1.path) `/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions`, (pagination_1.Page), { body, method: 'post', ...options });
+        return this._client.getAPIList((0, path_1.path) `/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions`, (pagination_1.Page), { body, method: 'post', ...options, __security: { adminAPIKeyAuth: true } });
     }
     /**
      * **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
@@ -32,20 +35,34 @@ class Permissions extends resource_1.APIResource {
      * Organization owners can use this endpoint to view all permissions for a
      * fine-tuned model checkpoint.
      *
-     * @example
-     * ```ts
-     * const permission =
-     *   await client.fineTuning.checkpoints.permissions.retrieve(
-     *     'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
-     *   );
-     * ```
+     * @deprecated Retrieve is deprecated. Please swap to the paginated list method instead.
      */
     retrieve(fineTunedModelCheckpoint, query = {}, options) {
         return this._client.get((0, path_1.path) `/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions`, {
             query,
             ...options,
+            __security: { adminAPIKeyAuth: true },
         });
     }
+    /**
+     * **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
+     *
+     * Organization owners can use this endpoint to view all permissions for a
+     * fine-tuned model checkpoint.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const permissionListResponse of client.fineTuning.checkpoints.permissions.list(
+     *   'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(fineTunedModelCheckpoint, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions`, (pagination_1.ConversationCursorPage), { query, ...options, __security: { adminAPIKeyAuth: true } });
+    }
     /**
      * **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
      *
@@ -66,7 +83,7 @@ class Permissions extends resource_1.APIResource {
      */
     delete(permissionID, params, options) {
         const { fine_tuned_model_checkpoint } = params;
-        return this._client.delete((0, path_1.path) `/fine_tuning/checkpoints/${fine_tuned_model_checkpoint}/permissions/${permissionID}`, options);
+        return this._client.delete((0, path_1.path) `/fine_tuning/checkpoints/${fine_tuned_model_checkpoint}/permissions/${permissionID}`, { ...options, __security: { adminAPIKeyAuth: true } });
     }
 }
 exports.Permissions = Permissions;

package/dist/node_modules/openai/resources/fine-tuning/jobs/checkpoints.d.mts

@@ -1,6 +1,9 @@
 import { APIResource } from "../../../core/resource.mjs";
 import { CursorPage, type CursorPageParams, PagePromise } from "../../../core/pagination.mjs";
 import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export declare class Checkpoints extends APIResource {
     /**
      * List checkpoints for a fine-tuning job.

package/dist/node_modules/openai/resources/fine-tuning/jobs/checkpoints.d.ts

@@ -1,6 +1,9 @@
 import { APIResource } from "../../../core/resource.js";
 import { CursorPage, type CursorPageParams, PagePromise } from "../../../core/pagination.js";
 import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export declare class Checkpoints extends APIResource {
     /**
      * List checkpoints for a fine-tuning job.

package/dist/node_modules/openai/resources/fine-tuning/jobs/checkpoints.js

@@ -5,6 +5,9 @@ exports.Checkpoints = void 0;
 const resource_1 = require("../../../core/resource.js");
 const pagination_1 = require("../../../core/pagination.js");
 const path_1 = require("../../../internal/utils/path.js");
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 class Checkpoints extends resource_1.APIResource {
     /**
      * List checkpoints for a fine-tuning job.
@@ -20,7 +23,7 @@ class Checkpoints extends resource_1.APIResource {
      * ```
      */
     list(fineTuningJobID, query = {}, options) {
-        return this._client.getAPIList((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/checkpoints`, (pagination_1.CursorPage), { query, ...options });
+        return this._client.getAPIList((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/checkpoints`, (pagination_1.CursorPage), { query, ...options, __security: { bearerAuth: true } });
     }
 }
 exports.Checkpoints = Checkpoints;

package/dist/node_modules/openai/resources/fine-tuning/jobs/jobs.d.mts

@@ -6,6 +6,9 @@ import { CheckpointListParams, Checkpoints, FineTuningJobCheckpoint, FineTuningJ
 import { APIPromise } from "../../../core/api-promise.mjs";
 import { CursorPage, type CursorPageParams, PagePromise } from "../../../core/pagination.mjs";
 import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export declare class Jobs extends APIResource {
     checkpoints: CheckpointsAPI.Checkpoints;
     /**

package/dist/node_modules/openai/resources/fine-tuning/jobs/jobs.d.ts

@@ -6,6 +6,9 @@ import { CheckpointListParams, Checkpoints, FineTuningJobCheckpoint, FineTuningJ
 import { APIPromise } from "../../../core/api-promise.js";
 import { CursorPage, type CursorPageParams, PagePromise } from "../../../core/pagination.js";
 import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 export declare class Jobs extends APIResource {
     checkpoints: CheckpointsAPI.Checkpoints;
     /**

package/dist/node_modules/openai/resources/fine-tuning/jobs/jobs.js

@@ -8,6 +8,9 @@ const CheckpointsAPI = tslib_1.__importStar(require("./checkpoints.js"));
 const checkpoints_1 = require("./checkpoints.js");
 const pagination_1 = require("../../../core/pagination.js");
 const path_1 = require("../../../internal/utils/path.js");
+/**
+ * Manage fine-tuning jobs to tailor a model to your specific training data.
+ */
 class Jobs extends resource_1.APIResource {
     constructor() {
         super(...arguments);
@@ -31,7 +34,7 @@ class Jobs extends resource_1.APIResource {
      * ```
      */
     create(body, options) {
-        return this._client.post('/fine_tuning/jobs', { body, ...options });
+        return this._client.post('/fine_tuning/jobs', { body, ...options, __security: { bearerAuth: true } });
     }
     /**
      * Get info about a fine-tuning job.
@@ -46,7 +49,10 @@ class Jobs extends resource_1.APIResource {
      * ```
      */
     retrieve(fineTuningJobID, options) {
-        return this._client.get((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}`, options);
+        return this._client.get((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}`, {
+            ...options,
+            __security: { bearerAuth: true },
+        });
     }
     /**
      * List your organization's fine-tuning jobs
@@ -60,7 +66,11 @@ class Jobs extends resource_1.APIResource {
      * ```
      */
     list(query = {}, options) {
-        return this._client.getAPIList('/fine_tuning/jobs', (pagination_1.CursorPage), { query, ...options });
+        return this._client.getAPIList('/fine_tuning/jobs', (pagination_1.CursorPage), {
+            query,
+            ...options,
+            __security: { bearerAuth: true },
+        });
     }
     /**
      * Immediately cancel a fine-tune job.
@@ -73,7 +83,10 @@ class Jobs extends resource_1.APIResource {
      * ```
      */
     cancel(fineTuningJobID, options) {
-        return this._client.post((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/cancel`, options);
+        return this._client.post((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/cancel`, {
+            ...options,
+            __security: { bearerAuth: true },
+        });
     }
     /**
      * Get status updates for a fine-tuning job.
@@ -89,7 +102,7 @@ class Jobs extends resource_1.APIResource {
      * ```
      */
     listEvents(fineTuningJobID, query = {}, options) {
-        return this._client.getAPIList((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/events`, (pagination_1.CursorPage), { query, ...options });
+        return this._client.getAPIList((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/events`, (pagination_1.CursorPage), { query, ...options, __security: { bearerAuth: true } });
     }
     /**
      * Pause a fine-tune job.
@@ -102,7 +115,10 @@ class Jobs extends resource_1.APIResource {
      * ```
      */
     pause(fineTuningJobID, options) {
-        return this._client.post((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/pause`, options);
+        return this._client.post((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/pause`, {
+            ...options,
+            __security: { bearerAuth: true },
+        });
     }
     /**
      * Resume a fine-tune job.
@@ -115,7 +131,10 @@ class Jobs extends resource_1.APIResource {
      * ```
      */
     resume(fineTuningJobID, options) {
-        return this._client.post((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/resume`, options);
+        return this._client.post((0, path_1.path) `/fine_tuning/jobs/${fineTuningJobID}/resume`, {
+            ...options,
+            __security: { bearerAuth: true },
+        });
     }
 }
 exports.Jobs = Jobs;

package/dist/node_modules/openai/resources/images.d.mts

@@ -4,6 +4,9 @@ import { APIPromise } from "../core/api-promise.mjs";
 import { Stream } from "../core/streaming.mjs";
 import { type Uploadable } from "../core/uploads.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Given a prompt and/or an input image, the model will generate a new image.
+ */
 export declare class Images extends APIResource {
     /**
      * Creates a variation of a given image. This endpoint only supports `dall-e-2`.
@@ -304,7 +307,7 @@ export interface ImageGenPartialImageEvent {
  * Emitted when a partial image is available during image generation streaming.
  */
 export type ImageGenStreamEvent = ImageGenPartialImageEvent | ImageGenCompletedEvent;
-export type ImageModel = 'gpt-image-1.5' | 'dall-e-2' | 'dall-e-3' | 'gpt-image-1' | 'gpt-image-1-mini';
+export type ImageModel = 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-2' | 'gpt-image-2-2026-04-21' | 'gpt-image-1.5' | 'chatgpt-image-latest' | 'dall-e-2' | 'dall-e-3';
 /**
  * The response from the image generation endpoint.
  */
@@ -433,10 +436,10 @@ export interface ImageEditParamsBase {
     /**
      * The image(s) to edit. Must be a supported image file or an array of images.
      *
-     * For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
-     * `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
-     * 50MB. You can provide up to 16 images. `chatgpt-image-latest` follows the same
-     * input constraints as GPT image models.
+     * For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+     * `gpt-image-2`, `gpt-image-2-2026-04-21`, and `chatgpt-image-latest`), each image
+     * should be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to
+     * 16 images.
      *
      * For `dall-e-2`, you can only provide one image, and it should be a square `png`
      * file less than 4MB.
@@ -449,9 +452,14 @@ export interface ImageEditParamsBase {
     prompt: string;
     /**
      * Allows to set transparency for the background of the generated image(s). This
-     * parameter is only supported for the GPT image models. Must be one of
-     * `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
-     * model will automatically determine the best background for the image.
+     * parameter is only supported for GPT image models that support transparent
+     * backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+     * When `auto` is used, the model will automatically determine the best background
+     * for the image.
+     *
+     * `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+     * backgrounds. Requests with `background` set to `transparent` will return an
+     * error for these models; use `opaque` or `auto` instead.
      *
      * If `transparent`, the output format needs to support transparency, so it should
      * be set to either `png` (default value) or `webp`.
@@ -472,7 +480,10 @@ export interface ImageEditParamsBase {
      */
     mask?: Uploadable;
     /**
-     * The model to use for image generation. Defaults to `gpt-image-1.5`.
+     * The model to use for image generation. One of `dall-e-2` or a GPT image model
+     * (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+     * `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`). Defaults to
+     * `gpt-image-1.5`.
      */
     model?: (string & {}) | ImageModel | null;
     /**
@@ -513,11 +524,19 @@ export interface ImageEditParamsBase {
      */
     response_format?: 'url' | 'b64_json' | null;
     /**
-     * The size of the generated images. Must be one of `1024x1024`, `1536x1024`
-     * (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
-     * models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
+     * The size of the generated images. For `gpt-image-2` and
+     * `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+     * strings, for example `1536x864`. Width and height must both be divisible by 16
+     * and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+     * `2560x1440` are experimental, and the maximum supported resolution is
+     * `3840x2160`. The requested size must also satisfy the model's current pixel and
+     * edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+     * supported by the GPT image models; `auto` is supported for models that allow
+     * automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+     * `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+     * `1024x1792`.
      */
-    size?: '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
+    size?: (string & {}) | '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
     /**
      * Edit the image in streaming mode. Defaults to `false`. See the
      * [Image generation guide](https://platform.openai.com/docs/guides/image-generation)
@@ -561,9 +580,14 @@ export interface ImageGenerateParamsBase {
     prompt: string;
     /**
      * Allows to set transparency for the background of the generated image(s). This
-     * parameter is only supported for the GPT image models. Must be one of
-     * `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
-     * model will automatically determine the best background for the image.
+     * parameter is only supported for GPT image models that support transparent
+     * backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+     * When `auto` is used, the model will automatically determine the best background
+     * for the image.
+     *
+     * `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+     * backgrounds. Requests with `background` set to `transparent` will return an
+     * error for these models; use `opaque` or `auto` instead.
      *
      * If `transparent`, the output format needs to support transparency, so it should
      * be set to either `png` (default value) or `webp`.
@@ -571,8 +595,9 @@ export interface ImageGenerateParamsBase {
     background?: 'transparent' | 'opaque' | 'auto' | null;
     /**
      * The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT
-     * image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`). Defaults to
-     * `dall-e-2` unless a parameter specific to the GPT image models is used.
+     * image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+     * or `gpt-image-2-2026-04-21`). Defaults to `dall-e-2` unless a parameter specific
+     * to the GPT image models is used.
      */
     model?: (string & {}) | ImageModel | null;
     /**
@@ -624,12 +649,19 @@ export interface ImageGenerateParamsBase {
      */
     response_format?: 'url' | 'b64_json' | null;
     /**
-     * The size of the generated images. Must be one of `1024x1024`, `1536x1024`
-     * (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
-     * models, one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`, and one of
-     * `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.
-     */
-    size?: 'auto' | '1024x1024' | '1536x1024' | '1024x1536' | '256x256' | '512x512' | '1792x1024' | '1024x1792' | null;
+     * The size of the generated images. For `gpt-image-2` and
+     * `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+     * strings, for example `1536x864`. Width and height must both be divisible by 16
+     * and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+     * `2560x1440` are experimental, and the maximum supported resolution is
+     * `3840x2160`. The requested size must also satisfy the model's current pixel and
+     * edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+     * supported by the GPT image models; `auto` is supported for models that allow
+     * automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+     * `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+     * `1024x1792`.
+     */
+    size?: (string & {}) | 'auto' | '1024x1024' | '1536x1024' | '1024x1536' | '256x256' | '512x512' | '1792x1024' | '1024x1792' | null;
     /**
      * Generate the image in streaming mode. Defaults to `false`. See the
      * [Image generation guide](https://platform.openai.com/docs/guides/image-generation)

package/dist/node_modules/openai/resources/images.d.ts

@@ -4,6 +4,9 @@ import { APIPromise } from "../core/api-promise.js";
 import { Stream } from "../core/streaming.js";
 import { type Uploadable } from "../core/uploads.js";
 import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Given a prompt and/or an input image, the model will generate a new image.
+ */
 export declare class Images extends APIResource {
     /**
      * Creates a variation of a given image. This endpoint only supports `dall-e-2`.
@@ -304,7 +307,7 @@ export interface ImageGenPartialImageEvent {
  * Emitted when a partial image is available during image generation streaming.
  */
 export type ImageGenStreamEvent = ImageGenPartialImageEvent | ImageGenCompletedEvent;
-export type ImageModel = 'gpt-image-1.5' | 'dall-e-2' | 'dall-e-3' | 'gpt-image-1' | 'gpt-image-1-mini';
+export type ImageModel = 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-2' | 'gpt-image-2-2026-04-21' | 'gpt-image-1.5' | 'chatgpt-image-latest' | 'dall-e-2' | 'dall-e-3';
 /**
  * The response from the image generation endpoint.
  */
@@ -433,10 +436,10 @@ export interface ImageEditParamsBase {
     /**
      * The image(s) to edit. Must be a supported image file or an array of images.
      *
-     * For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
-     * `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
-     * 50MB. You can provide up to 16 images. `chatgpt-image-latest` follows the same
-     * input constraints as GPT image models.
+     * For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+     * `gpt-image-2`, `gpt-image-2-2026-04-21`, and `chatgpt-image-latest`), each image
+     * should be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to
+     * 16 images.
      *
      * For `dall-e-2`, you can only provide one image, and it should be a square `png`
      * file less than 4MB.
@@ -449,9 +452,14 @@ export interface ImageEditParamsBase {
     prompt: string;
     /**
      * Allows to set transparency for the background of the generated image(s). This
-     * parameter is only supported for the GPT image models. Must be one of
-     * `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
-     * model will automatically determine the best background for the image.
+     * parameter is only supported for GPT image models that support transparent
+     * backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+     * When `auto` is used, the model will automatically determine the best background
+     * for the image.
+     *
+     * `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+     * backgrounds. Requests with `background` set to `transparent` will return an
+     * error for these models; use `opaque` or `auto` instead.
      *
      * If `transparent`, the output format needs to support transparency, so it should
      * be set to either `png` (default value) or `webp`.
@@ -472,7 +480,10 @@ export interface ImageEditParamsBase {
      */
     mask?: Uploadable;
     /**
-     * The model to use for image generation. Defaults to `gpt-image-1.5`.
+     * The model to use for image generation. One of `dall-e-2` or a GPT image model
+     * (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+     * `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`). Defaults to
+     * `gpt-image-1.5`.
      */
     model?: (string & {}) | ImageModel | null;
     /**
@@ -513,11 +524,19 @@ export interface ImageEditParamsBase {
      */
     response_format?: 'url' | 'b64_json' | null;
     /**
-     * The size of the generated images. Must be one of `1024x1024`, `1536x1024`
-     * (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
-     * models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
+     * The size of the generated images. For `gpt-image-2` and
+     * `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+     * strings, for example `1536x864`. Width and height must both be divisible by 16
+     * and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+     * `2560x1440` are experimental, and the maximum supported resolution is
+     * `3840x2160`. The requested size must also satisfy the model's current pixel and
+     * edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+     * supported by the GPT image models; `auto` is supported for models that allow
+     * automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+     * `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+     * `1024x1792`.
      */
-    size?: '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
+    size?: (string & {}) | '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
     /**
      * Edit the image in streaming mode. Defaults to `false`. See the
      * [Image generation guide](https://platform.openai.com/docs/guides/image-generation)
@@ -561,9 +580,14 @@ export interface ImageGenerateParamsBase {
     prompt: string;
     /**
      * Allows to set transparency for the background of the generated image(s). This
-     * parameter is only supported for the GPT image models. Must be one of
-     * `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
-     * model will automatically determine the best background for the image.
+     * parameter is only supported for GPT image models that support transparent
+     * backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+     * When `auto` is used, the model will automatically determine the best background
+     * for the image.
+     *
+     * `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+     * backgrounds. Requests with `background` set to `transparent` will return an
+     * error for these models; use `opaque` or `auto` instead.
      *
      * If `transparent`, the output format needs to support transparency, so it should
      * be set to either `png` (default value) or `webp`.
@@ -571,8 +595,9 @@ export interface ImageGenerateParamsBase {
     background?: 'transparent' | 'opaque' | 'auto' | null;
     /**
      * The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT
-     * image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`). Defaults to
-     * `dall-e-2` unless a parameter specific to the GPT image models is used.
+     * image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+     * or `gpt-image-2-2026-04-21`). Defaults to `dall-e-2` unless a parameter specific
+     * to the GPT image models is used.
      */
     model?: (string & {}) | ImageModel | null;
     /**
@@ -624,12 +649,19 @@ export interface ImageGenerateParamsBase {
      */
     response_format?: 'url' | 'b64_json' | null;
     /**
-     * The size of the generated images. Must be one of `1024x1024`, `1536x1024`
-     * (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
-     * models, one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`, and one of
-     * `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.
-     */
-    size?: 'auto' | '1024x1024' | '1536x1024' | '1024x1536' | '256x256' | '512x512' | '1792x1024' | '1024x1792' | null;
+     * The size of the generated images. For `gpt-image-2` and
+     * `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+     * strings, for example `1536x864`. Width and height must both be divisible by 16
+     * and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+     * `2560x1440` are experimental, and the maximum supported resolution is
+     * `3840x2160`. The requested size must also satisfy the model's current pixel and
+     * edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+     * supported by the GPT image models; `auto` is supported for models that allow
+     * automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+     * `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+     * `1024x1792`.
+     */
+    size?: (string & {}) | 'auto' | '1024x1024' | '1536x1024' | '1024x1536' | '256x256' | '512x512' | '1792x1024' | '1024x1792' | null;
     /**
      * Generate the image in streaming mode. Defaults to `false`. See the
      * [Image generation guide](https://platform.openai.com/docs/guides/image-generation)