Skip to main content
POST

Request Body

string
Text description of the image to generate, or the edit instructions when operation is "edit". Required unless profile supplies a default prompt.
string
default:"generate"
"generate" (text-to-image) or "edit" (image-to-image).
string
Gemini image model, e.g. "gemini-2.5-flash-image" or "gemini-3-pro-image-preview". Defaults to the first active image model in your workspace’s catalog, or the profile default.
string
Named enhancement profile, e.g. "ultrasound". Applies profile defaults for prompt, operation, and model.
string
Base64-encoded source image (with or without a data:image/png;base64, prefix). Required for operation: "edit" unless image_url or raw_image_id is given.
string
URL to a source image (PNG, JPEG, WebP, or GIF). Alternative to image.
string
UUID of a previously uploaded raw image (requires S3 storage) — re-runs enhancement on a stored upload instead of re-uploading.
string
default:"gemini"
"gemini" or "aws-nova-canvas". AWS Nova Canvas is only available with profile: "ultrasound".
boolean
Store raw/processed images in S3. Defaults to true if STORAGE_PROVIDER=s3 is configured for your workspace, otherwise false.

Response

string
Model used
string
Resolved prompt actually sent to the model
string
"generate" or "edit"
number
string
Base64-encoded PNG. Present when S3 storage isn’t enabled.
string
Profile used, if any
string
Present only with S3 storage enabled
string
Present only with S3 storage enabled
string
Signed URL to the raw image. Present only with S3 storage enabled
string
Signed URL to the generated/edited image. Present only with S3 storage enabled
string

Errors

GET /image

Returns endpoint metadata — useful for a quick connectivity check.