Skip to main content
POST
Generate an image from a text prompt

Body

application/json
prompt
string
required

Text prompt describing the image to generate

artifactId
string

Internal artifact id for async worker continuation

aspect
string

Aspect ratio: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9

async
boolean

Compatibility no-op: image generation is async by default

asyncWorker
boolean

Internal background worker mode

background
string

OpenAI background: transparent, opaque, auto

caption
string

Caption when sending (used with --send)

compression
string

OpenAI jpeg/webp output compression

format
string

OpenAI output format: png, jpeg, webp

mode
string

Legacy quality mode: fast or quality. Default: fast

model
string

Provider image model override

output
string

Output directory (default: /tmp)

provider
string

Image provider: gemini or openai

quality
string

OpenAI quality: low, medium, high, auto

send
boolean

Auto-send generated image to the current chat

size
string

Image size: 1K, 2K, 4K (default: 1K)

source
string

Source image path for editing/reference

sync
boolean

Wait for provider completion before returning

Response

Success — no @Returns schema declared; payload shape is loose.

The response is of type object.