generate_image
Generate one or more images from a text prompt, billed to the caller's credits.
Requires authentication. Anonymous image generation is available only via
the REST API (POST /v1/image-generators/{id}/runs); the MCP transport
always authenticates.
Resolution order for the generator (highest priority first):
A deployed
generatorref (uuid@versionor bare UUID): pins the deployed version config.The
modelcontrol path (authenticated one-off, ephemeral). Not usable from published templates.A tier
generatorref (system:<tier>): resolves to the tier's current best model (auto-upgrade). Available tiers:system:image-standard(default),system:image-premium,system:image-edit(image-to-image, requiresreference_image_url).Default:
system:image-standardwhen no generator or model is given.
generator and model are mutually exclusive.
For image_to_image generators, reference_image_url is required
and must be a public HTTP or HTTPS URL. For text_to_image generators,
providing reference_image_url is rejected.
Billing: spend is deducted from the caller's monthly credit balance.
BudgetExhausted (402) and AccountSuspended (403) propagate if the
balance is zero or the account is suspended.
visibility sets the access level of the hosted copy of each image:
public (default) returns a link that opens in any browser;
private returns a link only you can open and forward to people you
choose, while the plain URL stays locked.
Returns: {run_id, model_tier_or_model, image_url, image_urls, width, height, num_images, cost_usd, duration_ms, status, created_at, error_code, error_message, hosted_images}. hosted_images carries
the durable Goodeye-hosted copy of each image with its url (the
browser-viewable link) and visibility. The prompt is never stored;
only its hash is persisted on the run row.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payload | Yes | Payload for ``generate_image``: produce one or more images from a prompt, billed to the caller's credit balance. Supply ``generator`` to use a named system tier (e.g. ``system:image-standard``) or a deployed generator by ``uuid@version``. Supply ``model`` for an authenticated one-off using a concrete model identifier. ``generator`` and ``model`` are mutually exclusive; omitting both resolves to the default tier. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||