Creative
Beta

creative_generate_image

Start an image generation job in the connected workspace.

Operation: Write. Requires read-and-write OAuth consent.

Parameters

ParameterTypeRequiredDescription
bodyobjectYesImage generation input.
body.modelstringYesModel ID from creative_image_models_list.
body.promptstringYesDescribe the image to create or the change to make.
body.modestringNoUse async (the default) to receive a job immediately.
body.image_urlsarray of stringsNoPublic HTTPS URLs for reference images, if the model supports them.
body.aspect_ratiostringNoOutput aspect ratio supported by the model.
idempotency_keystringYesUse a unique key per action. Reuse it to retry identical input.
approval_receiptstringNoReceipt returned with the plan. Supply it after user confirmation.

Generation calls an external provider and can consume Creative credits. The first call returns a plan. After confirmation, resubmit the same input with its approval_receipt. Save data.job.id and pass it to creative_jobs_wait. A retry with the same key and input returns the same job. Check creative_image_models_get for model pricing and supported inputs.

Sample prompt

Generate one square image of a blue ceramic vase on a white background.