openai 7.27.0 → 7.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/lib/beta/agents/parse-result.d.mts +2 -2
- package/lib/beta/agents/parse-result.d.ts +2 -2
- package/package.json +1 -1
- package/resources/admin/organization/usage.d.mts +77 -11
- package/resources/admin/organization/usage.d.mts.map +1 -1
- package/resources/admin/organization/usage.d.ts +77 -11
- package/resources/admin/organization/usage.d.ts.map +1 -1
- package/resources/audio/audio.d.mts +4 -0
- package/resources/audio/audio.d.mts.map +1 -1
- package/resources/audio/audio.d.ts +4 -0
- package/resources/audio/audio.d.ts.map +1 -1
- package/resources/audio/audio.js +4 -0
- package/resources/audio/audio.js.map +1 -1
- package/resources/audio/audio.mjs +4 -0
- package/resources/audio/audio.mjs.map +1 -1
- package/resources/audio/index.d.mts +1 -0
- package/resources/audio/index.d.mts.map +1 -1
- package/resources/audio/index.d.ts +1 -0
- package/resources/audio/index.d.ts.map +1 -1
- package/resources/audio/index.js +3 -1
- package/resources/audio/index.js.map +1 -1
- package/resources/audio/index.mjs +1 -0
- package/resources/audio/index.mjs.map +1 -1
- package/resources/audio/speech.d.mts +2 -0
- package/resources/audio/speech.d.mts.map +1 -1
- package/resources/audio/speech.d.ts +2 -0
- package/resources/audio/speech.d.ts.map +1 -1
- package/resources/audio/voices.d.mts +119 -0
- package/resources/audio/voices.d.mts.map +1 -0
- package/resources/audio/voices.d.ts +119 -0
- package/resources/audio/voices.d.ts.map +1 -0
- package/resources/audio/voices.js +41 -0
- package/resources/audio/voices.js.map +1 -0
- package/resources/audio/voices.mjs +37 -0
- package/resources/audio/voices.mjs.map +1 -0
- package/resources/beta/agents/agents.d.mts +2 -4
- package/resources/beta/agents/agents.d.mts.map +1 -1
- package/resources/beta/agents/agents.d.ts +2 -4
- package/resources/beta/agents/agents.d.ts.map +1 -1
- package/resources/beta/agents/agents.js.map +1 -1
- package/resources/beta/agents/agents.mjs.map +1 -1
- package/resources/beta/agents/sessions/sessions.d.mts +2 -4
- package/resources/beta/agents/sessions/sessions.d.mts.map +1 -1
- package/resources/beta/agents/sessions/sessions.d.ts +2 -4
- package/resources/beta/agents/sessions/sessions.d.ts.map +1 -1
- package/resources/beta/agents/sessions/sessions.js.map +1 -1
- package/resources/beta/agents/sessions/sessions.mjs.map +1 -1
- package/resources/beta/responses/responses.d.mts +1 -3
- package/resources/beta/responses/responses.d.mts.map +1 -1
- package/resources/beta/responses/responses.d.ts +1 -3
- package/resources/beta/responses/responses.d.ts.map +1 -1
- package/resources/beta/responses/responses.js.map +1 -1
- package/resources/beta/responses/responses.mjs.map +1 -1
- package/resources/chat/completions/completions.d.mts +2 -1
- package/resources/chat/completions/completions.d.mts.map +1 -1
- package/resources/chat/completions/completions.d.ts +2 -1
- package/resources/chat/completions/completions.d.ts.map +1 -1
- package/resources/chat/completions/completions.js.map +1 -1
- package/resources/chat/completions/completions.mjs.map +1 -1
- package/resources/images.d.mts +57 -72
- package/resources/images.d.mts.map +1 -1
- package/resources/images.d.ts +57 -72
- package/resources/images.d.ts.map +1 -1
- package/resources/images.js +4 -7
- package/resources/images.js.map +1 -1
- package/resources/images.mjs +4 -7
- package/resources/images.mjs.map +1 -1
- package/resources/realtime/realtime.d.mts +6 -4
- package/resources/realtime/realtime.d.mts.map +1 -1
- package/resources/realtime/realtime.d.ts +6 -4
- package/resources/realtime/realtime.d.ts.map +1 -1
- package/resources/realtime/realtime.js.map +1 -1
- package/resources/realtime/realtime.mjs.map +1 -1
- package/resources/responses/responses.d.mts +1 -3
- package/resources/responses/responses.d.mts.map +1 -1
- package/resources/responses/responses.d.ts +1 -3
- package/resources/responses/responses.d.ts.map +1 -1
- package/resources/responses/responses.js.map +1 -1
- package/resources/responses/responses.mjs.map +1 -1
- package/resources/shared.d.mts +64 -0
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +64 -0
- package/resources/shared.d.ts.map +1 -1
- package/resources/webhooks/webhooks.d.mts +211 -6
- package/resources/webhooks/webhooks.d.mts.map +1 -1
- package/resources/webhooks/webhooks.d.ts +211 -6
- package/resources/webhooks/webhooks.d.ts.map +1 -1
- package/resources/webhooks/webhooks.js.map +1 -1
- package/resources/webhooks/webhooks.mjs.map +1 -1
- package/src/resources/admin/organization/usage.ts +88 -11
- package/src/resources/audio/audio.ts +6 -0
- package/src/resources/audio/index.ts +1 -0
- package/src/resources/audio/speech.ts +2 -0
- package/src/resources/audio/voices.ts +152 -0
- package/src/resources/beta/agents/agents.ts +2 -4
- package/src/resources/beta/agents/sessions/sessions.ts +2 -4
- package/src/resources/beta/responses/responses.ts +1 -3
- package/src/resources/chat/completions/completions.ts +2 -1
- package/src/resources/images.ts +58 -73
- package/src/resources/realtime/realtime.ts +6 -4
- package/src/resources/responses/responses.ts +1 -3
- package/src/resources/shared.ts +64 -0
- package/src/resources/webhooks/api.md +5 -0
- package/src/resources/webhooks/webhooks.ts +273 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/images.d.mts
CHANGED
|
@@ -9,19 +9,16 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
9
9
|
*/
|
|
10
10
|
export declare class Images extends APIResource {
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* This endpoint is retired and no longer available. Use the image edits endpoint
|
|
13
|
+
* with a GPT Image model and a prompt to create a variation of an image. The
|
|
14
|
+
* request and response schemas below describe the legacy contract.
|
|
13
15
|
*
|
|
14
|
-
* @
|
|
15
|
-
* ```ts
|
|
16
|
-
* const imagesResponse = await client.images.createVariation({
|
|
17
|
-
* image: fs.createReadStream('otter.png'),
|
|
18
|
-
* });
|
|
19
|
-
* ```
|
|
16
|
+
* @deprecated
|
|
20
17
|
*/
|
|
21
18
|
createVariation(body: ImageCreateVariationParams, options?: RequestOptions): APIPromise<ImagesResponse>;
|
|
22
19
|
/**
|
|
23
20
|
* Creates an edited or extended image given one or more source images and a
|
|
24
|
-
* prompt. This endpoint supports GPT Image models
|
|
21
|
+
* prompt. This endpoint supports GPT Image models.
|
|
25
22
|
*
|
|
26
23
|
* @example
|
|
27
24
|
* ```ts
|
|
@@ -35,7 +32,7 @@ export declare class Images extends APIResource {
|
|
|
35
32
|
edit(body: ImageEditParamsStreaming, options?: RequestOptions): APIPromise<Stream<ImageEditStreamEvent>>;
|
|
36
33
|
edit(body: ImageEditParamsBase, options?: RequestOptions): APIPromise<Stream<ImageEditStreamEvent> | ImagesResponse>;
|
|
37
34
|
/**
|
|
38
|
-
* Creates an image given a prompt.
|
|
35
|
+
* Creates an image given a prompt using a GPT Image model.
|
|
39
36
|
* [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
|
|
40
37
|
*
|
|
41
38
|
* @example
|
|
@@ -54,19 +51,19 @@ export declare class Images extends APIResource {
|
|
|
54
51
|
*/
|
|
55
52
|
export interface Image {
|
|
56
53
|
/**
|
|
57
|
-
* The base64-encoded JSON of the generated image. Returned by default for
|
|
58
|
-
* image models,
|
|
59
|
-
*
|
|
54
|
+
* The base64-encoded JSON of the generated image. Returned by default for GPT
|
|
55
|
+
* image models, or when `response_format` is set to `b64_json` for models that
|
|
56
|
+
* support that parameter.
|
|
60
57
|
*/
|
|
61
58
|
b64_json?: string;
|
|
62
59
|
/**
|
|
63
|
-
*
|
|
60
|
+
* The revised prompt used to generate the image, for models that support prompt
|
|
61
|
+
* revision. Not returned by GPT image models.
|
|
64
62
|
*/
|
|
65
63
|
revised_prompt?: string;
|
|
66
64
|
/**
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* models.
|
|
65
|
+
* The URL of the generated image when `response_format` is set to `url` for models
|
|
66
|
+
* that support that parameter. Unsupported for GPT image models.
|
|
70
67
|
*/
|
|
71
68
|
url?: string;
|
|
72
69
|
}
|
|
@@ -306,7 +303,13 @@ export interface ImageGenPartialImageEvent {
|
|
|
306
303
|
* Emitted when a partial image is available during image generation streaming.
|
|
307
304
|
*/
|
|
308
305
|
export type ImageGenStreamEvent = ImageGenPartialImageEvent | ImageGenCompletedEvent;
|
|
309
|
-
|
|
306
|
+
/**
|
|
307
|
+
* Deprecated values:
|
|
308
|
+
*
|
|
309
|
+
* - "dall-e-2", "dall-e-3": This model was retired on May 12, 2026. Use a GPT
|
|
310
|
+
* image model instead.
|
|
311
|
+
*/
|
|
312
|
+
export type ImageModel = 'gpt-image-1.5' | 'gpt-image-2' | 'gpt-image-2-2026-04-21' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-sunburst-2026-09-08' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-flare-2026-09-08' | 'gpt-image-1' | 'gpt-image-1-mini' | 'chatgpt-image-latest' | 'dall-e-2' | 'dall-e-3';
|
|
310
313
|
/**
|
|
311
314
|
* The response from the image generation endpoint.
|
|
312
315
|
*/
|
|
@@ -404,8 +407,8 @@ export interface ImageCreateVariationParams {
|
|
|
404
407
|
*/
|
|
405
408
|
image: Uploadable;
|
|
406
409
|
/**
|
|
407
|
-
* The model
|
|
408
|
-
*
|
|
410
|
+
* The legacy model used by the retired image variations endpoint. This endpoint no
|
|
411
|
+
* longer accepts requests.
|
|
409
412
|
*/
|
|
410
413
|
model?: (string & {}) | ImageModel | null;
|
|
411
414
|
/**
|
|
@@ -441,14 +444,11 @@ export interface ImageEditParamsBase {
|
|
|
441
444
|
* `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`), each image should
|
|
442
445
|
* be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
|
|
443
446
|
* images.
|
|
444
|
-
*
|
|
445
|
-
* For `dall-e-2`, you can only provide one image, and it should be a square `png`
|
|
446
|
-
* file less than 4MB.
|
|
447
447
|
*/
|
|
448
448
|
image: Uploadable | Array<Uploadable>;
|
|
449
449
|
/**
|
|
450
|
-
* A text description of the desired image(s). The maximum length is
|
|
451
|
-
* characters for
|
|
450
|
+
* A text description of the desired image(s). The maximum length is 32000
|
|
451
|
+
* characters for the GPT image models.
|
|
452
452
|
*/
|
|
453
453
|
prompt: string;
|
|
454
454
|
/**
|
|
@@ -477,12 +477,11 @@ export interface ImageEditParamsBase {
|
|
|
477
477
|
*/
|
|
478
478
|
mask?: Uploadable;
|
|
479
479
|
/**
|
|
480
|
-
* The model to use for image
|
|
481
|
-
*
|
|
482
|
-
* `gpt-image-2-
|
|
483
|
-
* `gpt-image-2.5-
|
|
484
|
-
* `
|
|
485
|
-
* `gpt-image-1.5`.
|
|
480
|
+
* The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`,
|
|
481
|
+
* `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
|
|
482
|
+
* `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
|
|
483
|
+
* `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
|
|
484
|
+
* `chatgpt-image-latest`).
|
|
486
485
|
*/
|
|
487
486
|
model?: (string & {}) | ImageModel | null;
|
|
488
487
|
/**
|
|
@@ -516,29 +515,26 @@ export interface ImageEditParamsBase {
|
|
|
516
515
|
* `gpt-image-2.5-flare`, including their `2026-09-08` snapshots, also support
|
|
517
516
|
* `xhigh` and `max`. Defaults to `auto`.
|
|
518
517
|
*/
|
|
519
|
-
quality?: '
|
|
518
|
+
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | 'standard' | null;
|
|
520
519
|
/**
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
* generated. This parameter is only supported for `dall-e-2` (default is `url` for
|
|
524
|
-
* `dall-e-2`), as GPT image models always return base64-encoded images.
|
|
520
|
+
* @deprecated Legacy response format parameter for retired image models.
|
|
521
|
+
* Unsupported for GPT image models, which always return base64-encoded images.
|
|
525
522
|
*/
|
|
526
523
|
response_format?: 'url' | 'b64_json' | null;
|
|
527
524
|
/**
|
|
528
|
-
* The size of the generated images.
|
|
529
|
-
* `gpt-image-2
|
|
530
|
-
* `gpt-image-2.5-
|
|
531
|
-
* resolutions are supported as
|
|
532
|
-
* Width and height must both be
|
|
533
|
-
* must be between 1:3 and 3:1.
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
* `
|
|
538
|
-
*
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
size?: (string & {}) | '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
|
|
525
|
+
* The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
|
|
526
|
+
* `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
527
|
+
* `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
|
|
528
|
+
* `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as
|
|
529
|
+
* `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be
|
|
530
|
+
* divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1.
|
|
531
|
+
* Resolutions above `2560x1440` are experimental, and the maximum supported
|
|
532
|
+
* resolution is `3840x2160`. The requested size must also satisfy the model's
|
|
533
|
+
* current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and
|
|
534
|
+
* `1024x1536` are supported by the GPT image models; `auto` is supported for
|
|
535
|
+
* models that allow automatic sizing.
|
|
536
|
+
*/
|
|
537
|
+
size?: (string & {}) | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | '256x256' | '512x512' | null;
|
|
542
538
|
/**
|
|
543
539
|
* Edit the image in streaming mode. Defaults to `false`. See the
|
|
544
540
|
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
@@ -576,8 +572,7 @@ export type ImageGenerateParams = ImageGenerateParamsNonStreaming | ImageGenerat
|
|
|
576
572
|
export interface ImageGenerateParamsBase {
|
|
577
573
|
/**
|
|
578
574
|
* A text description of the desired image(s). The maximum length is 32000
|
|
579
|
-
* characters
|
|
580
|
-
* characters for `dall-e-3`.
|
|
575
|
+
* characters.
|
|
581
576
|
*/
|
|
582
577
|
prompt: string;
|
|
583
578
|
/**
|
|
@@ -593,12 +588,11 @@ export interface ImageGenerateParamsBase {
|
|
|
593
588
|
*/
|
|
594
589
|
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
595
590
|
/**
|
|
596
|
-
* The model to use for image generation.
|
|
597
|
-
*
|
|
598
|
-
* `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
591
|
+
* The GPT image model to use for image generation. Specify a model explicitly.
|
|
592
|
+
* Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
|
|
593
|
+
* `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
599
594
|
* `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
600
|
-
* `gpt-image-2.5-flare-2026-09-08
|
|
601
|
-
* specific to the GPT image models is used.
|
|
595
|
+
* `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
|
|
602
596
|
*/
|
|
603
597
|
model?: (string & {}) | ImageModel | null;
|
|
604
598
|
/**
|
|
@@ -608,8 +602,7 @@ export interface ImageGenerateParamsBase {
|
|
|
608
602
|
*/
|
|
609
603
|
moderation?: 'low' | 'auto' | null;
|
|
610
604
|
/**
|
|
611
|
-
* The number of images to generate. Must be between 1 and 10.
|
|
612
|
-
* `n=1` is supported.
|
|
605
|
+
* The number of images to generate. Must be between 1 and 10.
|
|
613
606
|
*/
|
|
614
607
|
n?: number | null;
|
|
615
608
|
/**
|
|
@@ -640,15 +633,11 @@ export interface ImageGenerateParamsBase {
|
|
|
640
633
|
* - `high`, `medium` and `low` are supported for the GPT image models.
|
|
641
634
|
* - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
|
|
642
635
|
* `2026-09-08` snapshots, also support `xhigh` and `max`.
|
|
643
|
-
* - `hd` and `standard` are supported for `dall-e-3`.
|
|
644
|
-
* - `standard` is the only option for `dall-e-2`.
|
|
645
636
|
*/
|
|
646
|
-
quality?: '
|
|
637
|
+
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | 'standard' | 'hd' | null;
|
|
647
638
|
/**
|
|
648
|
-
*
|
|
649
|
-
*
|
|
650
|
-
* after the image has been generated. This parameter isn't supported for the GPT
|
|
651
|
-
* image models, which always return base64-encoded images.
|
|
639
|
+
* @deprecated Legacy response format parameter for retired image models.
|
|
640
|
+
* Unsupported for GPT image models, which always return base64-encoded images.
|
|
652
641
|
*/
|
|
653
642
|
response_format?: 'url' | 'b64_json' | null;
|
|
654
643
|
/**
|
|
@@ -661,9 +650,7 @@ export interface ImageGenerateParamsBase {
|
|
|
661
650
|
* the maximum supported resolution is `3840x2160`. The requested size must also
|
|
662
651
|
* satisfy the model's current pixel and edge limits. The standard sizes
|
|
663
652
|
* `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
|
|
664
|
-
* `auto` is supported for models that allow automatic sizing.
|
|
665
|
-
* one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
|
|
666
|
-
* `1024x1024`, `1792x1024`, or `1024x1792`.
|
|
653
|
+
* `auto` is supported for models that allow automatic sizing.
|
|
667
654
|
*/
|
|
668
655
|
size?: (string & {}) | 'auto' | '1024x1024' | '1536x1024' | '1024x1536' | '256x256' | '512x512' | '1792x1024' | '1024x1792' | null;
|
|
669
656
|
/**
|
|
@@ -673,10 +660,8 @@ export interface ImageGenerateParamsBase {
|
|
|
673
660
|
*/
|
|
674
661
|
stream?: boolean | null;
|
|
675
662
|
/**
|
|
676
|
-
*
|
|
677
|
-
*
|
|
678
|
-
* towards generating hyper-real and dramatic images. Natural causes the model to
|
|
679
|
-
* produce more natural, less hyper-real looking images.
|
|
663
|
+
* @deprecated Legacy style parameter for retired image models. Unsupported for GPT
|
|
664
|
+
* image models; describe the desired style in the prompt instead.
|
|
680
665
|
*/
|
|
681
666
|
style?: 'vivid' | 'natural' | null;
|
|
682
667
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"images.d.mts","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,8BAA0B;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,4BAAwB;AAClD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAU7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"images.d.mts","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,8BAA0B;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,4BAAwB;AAClD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAU7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;OAMG;IACH,eAAe,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IASvG;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAC7F,IAAI,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACxG,IAAI,CACF,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,oBAAoB,CAAC,GAAG,cAAc,CAAC;IAsB5D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IACrG,QAAQ,CACN,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAC1C,QAAQ,CACN,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,mBAAmB,CAAC,GAAG,cAAc,CAAC;CAe5D;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;;OAGG;IACH,KAAK,EAAE,uBAAuB,CAAC,KAAK,CAAC;CACtC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,0BAA0B,GAAG,uBAAuB,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;IAEnC;;;OAGG;IACH,KAAK,EAAE,sBAAsB,CAAC,KAAK,CAAC;CACrC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,gCAAgC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,yBAAyB,GAAG,sBAAsB,CAAC;AAErF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB,eAAe,GACf,aAAa,GACb,wBAAwB,GACxB,wBAAwB,GACxB,mCAAmC,GACnC,qBAAqB,GACrB,gCAAgC,GAChC,aAAa,GACb,kBAAkB,GAClB,sBAAsB,GACtB,UAAU,GACV,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAExC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;IAEtD;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC;IAE/D;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC;CAC9B;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC;KACnD;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;QAED;;WAEG;QACH,UAAiB,mBAAmB;YAClC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,KAAK,EAAE,UAAU,CAAC;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,IAAI,CAAC;IAElD;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,eAAe,GAAG,2BAA2B,GAAG,wBAAwB,CAAC;AAErF,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;OASG;IACH,KAAK,EAAE,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/C;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;IAEnF;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;IAEvG;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,eAAe,CAAC;IAC/B,KAAY,2BAA2B,GAAG,SAAS,CAAC,2BAA2B,CAAC;IAChF,KAAY,wBAAwB,GAAG,SAAS,CAAC,wBAAwB,CAAC;CAC3E;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE;;;;OAIG;IACH,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,MAAM,mBAAmB,GAAG,+BAA+B,GAAG,4BAA4B,CAAC;AAEjG,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAEtD;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/C;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC;IAE1F;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EACD,CAAC,MAAM,GAAG,EAAE,CAAC,GACb,MAAM,GACN,WAAW,GACX,WAAW,GACX,WAAW,GACX,SAAS,GACT,SAAS,GACT,WAAW,GACX,WAAW,GACX,IAAI,CAAC;IAET;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC,KAAY,+BAA+B,GAAG,SAAS,CAAC,+BAA+B,CAAC;IACxF,KAAY,4BAA4B,GAAG,SAAS,CAAC,4BAA4B,CAAC;CACnF;AAED,MAAM,WAAW,+BAAgC,SAAQ,uBAAuB;IAC9E;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E;;;;OAIG;IACH,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
package/resources/images.d.ts
CHANGED
|
@@ -9,19 +9,16 @@ import { RequestOptions } from "../internal/request-options.js";
|
|
|
9
9
|
*/
|
|
10
10
|
export declare class Images extends APIResource {
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* This endpoint is retired and no longer available. Use the image edits endpoint
|
|
13
|
+
* with a GPT Image model and a prompt to create a variation of an image. The
|
|
14
|
+
* request and response schemas below describe the legacy contract.
|
|
13
15
|
*
|
|
14
|
-
* @
|
|
15
|
-
* ```ts
|
|
16
|
-
* const imagesResponse = await client.images.createVariation({
|
|
17
|
-
* image: fs.createReadStream('otter.png'),
|
|
18
|
-
* });
|
|
19
|
-
* ```
|
|
16
|
+
* @deprecated
|
|
20
17
|
*/
|
|
21
18
|
createVariation(body: ImageCreateVariationParams, options?: RequestOptions): APIPromise<ImagesResponse>;
|
|
22
19
|
/**
|
|
23
20
|
* Creates an edited or extended image given one or more source images and a
|
|
24
|
-
* prompt. This endpoint supports GPT Image models
|
|
21
|
+
* prompt. This endpoint supports GPT Image models.
|
|
25
22
|
*
|
|
26
23
|
* @example
|
|
27
24
|
* ```ts
|
|
@@ -35,7 +32,7 @@ export declare class Images extends APIResource {
|
|
|
35
32
|
edit(body: ImageEditParamsStreaming, options?: RequestOptions): APIPromise<Stream<ImageEditStreamEvent>>;
|
|
36
33
|
edit(body: ImageEditParamsBase, options?: RequestOptions): APIPromise<Stream<ImageEditStreamEvent> | ImagesResponse>;
|
|
37
34
|
/**
|
|
38
|
-
* Creates an image given a prompt.
|
|
35
|
+
* Creates an image given a prompt using a GPT Image model.
|
|
39
36
|
* [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
|
|
40
37
|
*
|
|
41
38
|
* @example
|
|
@@ -54,19 +51,19 @@ export declare class Images extends APIResource {
|
|
|
54
51
|
*/
|
|
55
52
|
export interface Image {
|
|
56
53
|
/**
|
|
57
|
-
* The base64-encoded JSON of the generated image. Returned by default for
|
|
58
|
-
* image models,
|
|
59
|
-
*
|
|
54
|
+
* The base64-encoded JSON of the generated image. Returned by default for GPT
|
|
55
|
+
* image models, or when `response_format` is set to `b64_json` for models that
|
|
56
|
+
* support that parameter.
|
|
60
57
|
*/
|
|
61
58
|
b64_json?: string;
|
|
62
59
|
/**
|
|
63
|
-
*
|
|
60
|
+
* The revised prompt used to generate the image, for models that support prompt
|
|
61
|
+
* revision. Not returned by GPT image models.
|
|
64
62
|
*/
|
|
65
63
|
revised_prompt?: string;
|
|
66
64
|
/**
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* models.
|
|
65
|
+
* The URL of the generated image when `response_format` is set to `url` for models
|
|
66
|
+
* that support that parameter. Unsupported for GPT image models.
|
|
70
67
|
*/
|
|
71
68
|
url?: string;
|
|
72
69
|
}
|
|
@@ -306,7 +303,13 @@ export interface ImageGenPartialImageEvent {
|
|
|
306
303
|
* Emitted when a partial image is available during image generation streaming.
|
|
307
304
|
*/
|
|
308
305
|
export type ImageGenStreamEvent = ImageGenPartialImageEvent | ImageGenCompletedEvent;
|
|
309
|
-
|
|
306
|
+
/**
|
|
307
|
+
* Deprecated values:
|
|
308
|
+
*
|
|
309
|
+
* - "dall-e-2", "dall-e-3": This model was retired on May 12, 2026. Use a GPT
|
|
310
|
+
* image model instead.
|
|
311
|
+
*/
|
|
312
|
+
export type ImageModel = 'gpt-image-1.5' | 'gpt-image-2' | 'gpt-image-2-2026-04-21' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-sunburst-2026-09-08' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-flare-2026-09-08' | 'gpt-image-1' | 'gpt-image-1-mini' | 'chatgpt-image-latest' | 'dall-e-2' | 'dall-e-3';
|
|
310
313
|
/**
|
|
311
314
|
* The response from the image generation endpoint.
|
|
312
315
|
*/
|
|
@@ -404,8 +407,8 @@ export interface ImageCreateVariationParams {
|
|
|
404
407
|
*/
|
|
405
408
|
image: Uploadable;
|
|
406
409
|
/**
|
|
407
|
-
* The model
|
|
408
|
-
*
|
|
410
|
+
* The legacy model used by the retired image variations endpoint. This endpoint no
|
|
411
|
+
* longer accepts requests.
|
|
409
412
|
*/
|
|
410
413
|
model?: (string & {}) | ImageModel | null;
|
|
411
414
|
/**
|
|
@@ -441,14 +444,11 @@ export interface ImageEditParamsBase {
|
|
|
441
444
|
* `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`), each image should
|
|
442
445
|
* be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
|
|
443
446
|
* images.
|
|
444
|
-
*
|
|
445
|
-
* For `dall-e-2`, you can only provide one image, and it should be a square `png`
|
|
446
|
-
* file less than 4MB.
|
|
447
447
|
*/
|
|
448
448
|
image: Uploadable | Array<Uploadable>;
|
|
449
449
|
/**
|
|
450
|
-
* A text description of the desired image(s). The maximum length is
|
|
451
|
-
* characters for
|
|
450
|
+
* A text description of the desired image(s). The maximum length is 32000
|
|
451
|
+
* characters for the GPT image models.
|
|
452
452
|
*/
|
|
453
453
|
prompt: string;
|
|
454
454
|
/**
|
|
@@ -477,12 +477,11 @@ export interface ImageEditParamsBase {
|
|
|
477
477
|
*/
|
|
478
478
|
mask?: Uploadable;
|
|
479
479
|
/**
|
|
480
|
-
* The model to use for image
|
|
481
|
-
*
|
|
482
|
-
* `gpt-image-2-
|
|
483
|
-
* `gpt-image-2.5-
|
|
484
|
-
* `
|
|
485
|
-
* `gpt-image-1.5`.
|
|
480
|
+
* The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`,
|
|
481
|
+
* `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
|
|
482
|
+
* `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
|
|
483
|
+
* `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
|
|
484
|
+
* `chatgpt-image-latest`).
|
|
486
485
|
*/
|
|
487
486
|
model?: (string & {}) | ImageModel | null;
|
|
488
487
|
/**
|
|
@@ -516,29 +515,26 @@ export interface ImageEditParamsBase {
|
|
|
516
515
|
* `gpt-image-2.5-flare`, including their `2026-09-08` snapshots, also support
|
|
517
516
|
* `xhigh` and `max`. Defaults to `auto`.
|
|
518
517
|
*/
|
|
519
|
-
quality?: '
|
|
518
|
+
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | 'standard' | null;
|
|
520
519
|
/**
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
* generated. This parameter is only supported for `dall-e-2` (default is `url` for
|
|
524
|
-
* `dall-e-2`), as GPT image models always return base64-encoded images.
|
|
520
|
+
* @deprecated Legacy response format parameter for retired image models.
|
|
521
|
+
* Unsupported for GPT image models, which always return base64-encoded images.
|
|
525
522
|
*/
|
|
526
523
|
response_format?: 'url' | 'b64_json' | null;
|
|
527
524
|
/**
|
|
528
|
-
* The size of the generated images.
|
|
529
|
-
* `gpt-image-2
|
|
530
|
-
* `gpt-image-2.5-
|
|
531
|
-
* resolutions are supported as
|
|
532
|
-
* Width and height must both be
|
|
533
|
-
* must be between 1:3 and 3:1.
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
* `
|
|
538
|
-
*
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
size?: (string & {}) | '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
|
|
525
|
+
* The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
|
|
526
|
+
* `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
527
|
+
* `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
|
|
528
|
+
* `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as
|
|
529
|
+
* `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be
|
|
530
|
+
* divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1.
|
|
531
|
+
* Resolutions above `2560x1440` are experimental, and the maximum supported
|
|
532
|
+
* resolution is `3840x2160`. The requested size must also satisfy the model's
|
|
533
|
+
* current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and
|
|
534
|
+
* `1024x1536` are supported by the GPT image models; `auto` is supported for
|
|
535
|
+
* models that allow automatic sizing.
|
|
536
|
+
*/
|
|
537
|
+
size?: (string & {}) | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | '256x256' | '512x512' | null;
|
|
542
538
|
/**
|
|
543
539
|
* Edit the image in streaming mode. Defaults to `false`. See the
|
|
544
540
|
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
@@ -576,8 +572,7 @@ export type ImageGenerateParams = ImageGenerateParamsNonStreaming | ImageGenerat
|
|
|
576
572
|
export interface ImageGenerateParamsBase {
|
|
577
573
|
/**
|
|
578
574
|
* A text description of the desired image(s). The maximum length is 32000
|
|
579
|
-
* characters
|
|
580
|
-
* characters for `dall-e-3`.
|
|
575
|
+
* characters.
|
|
581
576
|
*/
|
|
582
577
|
prompt: string;
|
|
583
578
|
/**
|
|
@@ -593,12 +588,11 @@ export interface ImageGenerateParamsBase {
|
|
|
593
588
|
*/
|
|
594
589
|
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
595
590
|
/**
|
|
596
|
-
* The model to use for image generation.
|
|
597
|
-
*
|
|
598
|
-
* `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
591
|
+
* The GPT image model to use for image generation. Specify a model explicitly.
|
|
592
|
+
* Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
|
|
593
|
+
* `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
599
594
|
* `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
600
|
-
* `gpt-image-2.5-flare-2026-09-08
|
|
601
|
-
* specific to the GPT image models is used.
|
|
595
|
+
* `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
|
|
602
596
|
*/
|
|
603
597
|
model?: (string & {}) | ImageModel | null;
|
|
604
598
|
/**
|
|
@@ -608,8 +602,7 @@ export interface ImageGenerateParamsBase {
|
|
|
608
602
|
*/
|
|
609
603
|
moderation?: 'low' | 'auto' | null;
|
|
610
604
|
/**
|
|
611
|
-
* The number of images to generate. Must be between 1 and 10.
|
|
612
|
-
* `n=1` is supported.
|
|
605
|
+
* The number of images to generate. Must be between 1 and 10.
|
|
613
606
|
*/
|
|
614
607
|
n?: number | null;
|
|
615
608
|
/**
|
|
@@ -640,15 +633,11 @@ export interface ImageGenerateParamsBase {
|
|
|
640
633
|
* - `high`, `medium` and `low` are supported for the GPT image models.
|
|
641
634
|
* - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
|
|
642
635
|
* `2026-09-08` snapshots, also support `xhigh` and `max`.
|
|
643
|
-
* - `hd` and `standard` are supported for `dall-e-3`.
|
|
644
|
-
* - `standard` is the only option for `dall-e-2`.
|
|
645
636
|
*/
|
|
646
|
-
quality?: '
|
|
637
|
+
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | 'standard' | 'hd' | null;
|
|
647
638
|
/**
|
|
648
|
-
*
|
|
649
|
-
*
|
|
650
|
-
* after the image has been generated. This parameter isn't supported for the GPT
|
|
651
|
-
* image models, which always return base64-encoded images.
|
|
639
|
+
* @deprecated Legacy response format parameter for retired image models.
|
|
640
|
+
* Unsupported for GPT image models, which always return base64-encoded images.
|
|
652
641
|
*/
|
|
653
642
|
response_format?: 'url' | 'b64_json' | null;
|
|
654
643
|
/**
|
|
@@ -661,9 +650,7 @@ export interface ImageGenerateParamsBase {
|
|
|
661
650
|
* the maximum supported resolution is `3840x2160`. The requested size must also
|
|
662
651
|
* satisfy the model's current pixel and edge limits. The standard sizes
|
|
663
652
|
* `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
|
|
664
|
-
* `auto` is supported for models that allow automatic sizing.
|
|
665
|
-
* one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
|
|
666
|
-
* `1024x1024`, `1792x1024`, or `1024x1792`.
|
|
653
|
+
* `auto` is supported for models that allow automatic sizing.
|
|
667
654
|
*/
|
|
668
655
|
size?: (string & {}) | 'auto' | '1024x1024' | '1536x1024' | '1024x1536' | '256x256' | '512x512' | '1792x1024' | '1024x1792' | null;
|
|
669
656
|
/**
|
|
@@ -673,10 +660,8 @@ export interface ImageGenerateParamsBase {
|
|
|
673
660
|
*/
|
|
674
661
|
stream?: boolean | null;
|
|
675
662
|
/**
|
|
676
|
-
*
|
|
677
|
-
*
|
|
678
|
-
* towards generating hyper-real and dramatic images. Natural causes the model to
|
|
679
|
-
* produce more natural, less hyper-real looking images.
|
|
663
|
+
* @deprecated Legacy style parameter for retired image models. Unsupported for GPT
|
|
664
|
+
* image models; describe the desired style in the prompt instead.
|
|
680
665
|
*/
|
|
681
666
|
style?: 'vivid' | 'natural' | null;
|
|
682
667
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,6BAA0B;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,2BAAwB;AAClD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAU7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,6BAA0B;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,2BAAwB;AAClD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAU7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;OAMG;IACH,eAAe,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IASvG;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAC7F,IAAI,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACxG,IAAI,CACF,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,oBAAoB,CAAC,GAAG,cAAc,CAAC;IAsB5D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IACrG,QAAQ,CACN,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAC1C,QAAQ,CACN,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,mBAAmB,CAAC,GAAG,cAAc,CAAC;CAe5D;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;;OAGG;IACH,KAAK,EAAE,uBAAuB,CAAC,KAAK,CAAC;CACtC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,0BAA0B,GAAG,uBAAuB,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;IAEnC;;;OAGG;IACH,KAAK,EAAE,sBAAsB,CAAC,KAAK,CAAC;CACrC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,gCAAgC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,yBAAyB,GAAG,sBAAsB,CAAC;AAErF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB,eAAe,GACf,aAAa,GACb,wBAAwB,GACxB,wBAAwB,GACxB,mCAAmC,GACnC,qBAAqB,GACrB,gCAAgC,GAChC,aAAa,GACb,kBAAkB,GAClB,sBAAsB,GACtB,UAAU,GACV,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAExC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;IAEtD;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC;IAE/D;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC;CAC9B;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC;KACnD;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;QAED;;WAEG;QACH,UAAiB,mBAAmB;YAClC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,KAAK,EAAE,UAAU,CAAC;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,IAAI,CAAC;IAElD;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,eAAe,GAAG,2BAA2B,GAAG,wBAAwB,CAAC;AAErF,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;OASG;IACH,KAAK,EAAE,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/C;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;IAEnF;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;IAEvG;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,eAAe,CAAC;IAC/B,KAAY,2BAA2B,GAAG,SAAS,CAAC,2BAA2B,CAAC;IAChF,KAAY,wBAAwB,GAAG,SAAS,CAAC,wBAAwB,CAAC;CAC3E;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE;;;;OAIG;IACH,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,MAAM,mBAAmB,GAAG,+BAA+B,GAAG,4BAA4B,CAAC;AAEjG,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAEtD;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/C;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC;IAE1F;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EACD,CAAC,MAAM,GAAG,EAAE,CAAC,GACb,MAAM,GACN,WAAW,GACX,WAAW,GACX,WAAW,GACX,SAAS,GACT,SAAS,GACT,WAAW,GACX,WAAW,GACX,IAAI,CAAC;IAET;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC,KAAY,+BAA+B,GAAG,SAAS,CAAC,+BAA+B,CAAC;IACxF,KAAY,4BAA4B,GAAG,SAAS,CAAC,4BAA4B,CAAC;CACnF;AAED,MAAM,WAAW,+BAAgC,SAAQ,uBAAuB;IAC9E;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E;;;;OAIG;IACH,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
package/resources/images.js
CHANGED
|
@@ -12,14 +12,11 @@ function resolveResourceRequestOptions(options, buildOptions) {
|
|
|
12
12
|
*/
|
|
13
13
|
class Images extends resource_1.APIResource {
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* This endpoint is retired and no longer available. Use the image edits endpoint
|
|
16
|
+
* with a GPT Image model and a prompt to create a variation of an image. The
|
|
17
|
+
* request and response schemas below describe the legacy contract.
|
|
16
18
|
*
|
|
17
|
-
* @
|
|
18
|
-
* ```ts
|
|
19
|
-
* const imagesResponse = await client.images.createVariation({
|
|
20
|
-
* image: fs.createReadStream('otter.png'),
|
|
21
|
-
* });
|
|
22
|
-
* ```
|
|
19
|
+
* @deprecated
|
|
23
20
|
*/
|
|
24
21
|
createVariation(body, options) {
|
|
25
22
|
return this._client.post('/images/variations', resolveResourceRequestOptions(options, (options) => (0, uploads_1.multipartFormRequestOptions)({ body, ...options, __security: { bearerAuth: true } }, this._client)));
|
package/resources/images.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"images.js","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":";AAAA,qFAAqF;;;AAErF,kDAA+C;AAM/C,oDAAkE;AAElE,SAAS,6BAA6B,CACpC,OAAmC,EACnC,YAA+F;IAE/F,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC
|
|
1
|
+
{"version":3,"file":"images.js","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":";AAAA,qFAAqF;;;AAErF,kDAA+C;AAM/C,oDAAkE;AAElE,SAAS,6BAA6B,CACpC,OAAmC,EACnC,YAA+F;IAE/F,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;OAMG;IACH,eAAe,CAAC,IAAgC,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,oBAAoB,EACpB,6BAA6B,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACjD,IAAA,qCAA2B,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAClG,CACF,CAAC;IACJ,CAAC;IAoBD,IAAI,CACF,IAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,eAAe,EACf,6BAA6B,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACjD,IAAA,qCAA2B,EACzB;YACE,IAAI;YACJ,GAAG,OAAO;YACV,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK;YAC5B,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE;YAC5F,UAAU,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;SACjC,EACD,IAAI,CAAC,OAAO,CACb,CACF,CACuE,CAAC;IAC7E,CAAC;IAsBD,QAAQ,CACN,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,qBAAqB,EACrB,6BAA6B,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK;YAC5B,UAAU,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;SACjC,CAAC,CAAC,CACoE,CAAC;IAC5E,CAAC;CACF;AA1FD,wBA0FC"}
|