Files

Generate image

Generate images with the host's default image model or an explicit compatible model.

Zo supports a reviewed catalog of image models through Vercel AI Gateway. The default is set per workspace in AI settings.

Parameters#

promptstringrequired

Specific description of the image to create.

file_stemstringrequired

The base name for the output files (e.g., "myimg" will create "myimg_1.png", "myimg_2.png", etc.).

nnumberdefault: 1

Number of images. The selected model's catalog profile sets the allowed values.

output_dirstringdefault: ""

The directory where the generated images will be saved. Defaults to /home/workspace/Images.

aspect_ratiostringdefault: 1:1

Desired aspect ratio, such as "16:9", "1:1", or "3:4".

providerstringdefault: ""

Deprecated compatibility alias: "google" or "openai". Prefer model.

modelstringdefault: ""

Optional public model ID. Empty uses the workspace default.

reference_filepathsstring[]

Reserved ordered reference images. Current public generation profiles reject these; use edit_image.

qualitystringdefault: ""

Optional normalized quality. Unsupported values fail before provider work.

sizestringdefault: ""

Optional exact canvas size for models that expose size instead of aspect_ratio.