Class Images

Hierarchy

APIResource
- Images

Index

Constructors

Methods

createVariation edit generate

Constructors

constructor

new Images(client): Images
Parameters
- client: OpenAI
Returns Images
Inherited from APIResource.constructor
- Defined in node_modules/openai/resource.d.ts:4

Methods

createVariation

createVariation(body, options?): APIPromise<ImagesResponse>
Creates a variation of a given image. This endpoint only supports dall-e-2.
Parameters
- body: ImageCreateVariationParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ImagesResponse>
- Defined in node_modules/openai/resources/images.d.ts:7

edit

edit(body, options?): APIPromise<ImagesResponse>
Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2.
Parameters
- body: ImageEditParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ImagesResponse>
- Defined in node_modules/openai/resources/images.d.ts:12

generate

generate(body, options?): APIPromise<ImagesResponse>
Creates an image given a prompt. Learn more.
Parameters
- body: ImageGenerateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ImagesResponse>
- Defined in node_modules/openai/resources/images.d.ts:17