Creation Methods - IMG Processing

upload

Uploads a new image to the system from a file. This method is used to create a new Image object by uploading an image file.

upload(body: ImageUploadParams, options?: RequestOptions): APIPromise<ImageObject>;

Show uploadOptions

body

object

required

The body parameters for uploading an image.

Show ImageUploadParams

image

Uploadable

required

The image file to upload. It must be a valid image format (jpeg, png, webp) and not larger than 20MB.

name

string

required

The name of the image to identify it on the dashboard.

Show Examples

import fs from 'fs';

const imageObject = await client.images.upload({
    image: fs.createReadStream('path/to/file'),
    name: 'example-image',
});

createFromURL

Creates a new image by downloading it from a URL. This method is used when you have an image hosted online and want to import it into the system.

createFromURL(body: ImageCreateFromURLParams, options?: RequestOptions): APIPromise<ImageObject>;

Show createFromURLOptions

body

object

required

The body parameters for creating an image from a URL.

Show ImageCreateFromURLParams

name

string

required

The name of the image to identify it on the dashboard.

url

string

required

The URL of the image to download. It must point to a supported image format (jpeg, png, webp).

Show Examples

const imageObject = await client.images.createFromURL({
    name: 'example-image',
    url: 'https://example.com/image.jpg',
});

imagine

Generates a new image using AI based on a text prompt. This method allows you to create images from textual descriptions.

imagine(body: ImageImagineParams, options?: RequestOptions): APIPromise<ImageObject>;

Show imagineOptions

body

object

required

The body parameters for generating an image using AI.

Show ImageImagineParams

name

string

required

The name of the image to identify it on the dashboard.

prompt

string

required

The prompt for the image. It should describe what you want to see in the generated image.

model

string

The model to use for the image. If not provided, the default model will be used.

negative_prompt

string

The negative prompt for the image. It should describe what you don’t want to see in the generated image.

seed

number

The seed for the image. It is used to generate the image. If not provided, a random seed will be used.

Show Examples

const imageObject = await client.images.imagine({
    name: 'example-image',
    prompt: 'A beautiful sunset over the ocean.',
});

Get Started

Methods