generate_image
Auto-generated from the Python tool registry. Do not hand-edit outside
<!-- examples:start --><!-- examples:end -->blocks — the generator (tools/generate_docs_reference.py) will overwrite them.
Group: asset_gen · Module: services.tools.generate_image
Description
Generate 2D images with AI providers (fal.ai, OpenRouter) and import them as textures/sprites into the Unity project. Bring-your-own-key: provider keys live in the editor's secure store and never cross the bridge.
ACTIONS:
- generate: Submit an image job (text->image or image->image). Returns { job_id }; poll with the status action. Params: provider, mode (text|image), prompt, image_path|image_url, model, transparent, width, height, name, output_folder.
- remove_background: Unsupported in this version; returns an error instead of a job_id.
- status: Poll an async job by job_id -> { state, progress, assetPath?, error? }.
- cancel: Cancel an in-flight job by job_id.
- list_providers: List configured image providers and capabilities (no key values).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
action | Literal['generate', 'remove_background', 'status', 'cancel', 'list_providers'] | yes | Action to perform. |
provider | str | None | — | Provider id (fal, openrouter). |
mode | str | None | — | Generation mode: text or image. |
prompt | str | None | — | Text prompt for text->image. |
image_path | str | None | — | Path to a source image for image->image mode. |
image_url | str | None | — | URL of a source image for image->image. |
model | str | None | — | Provider model id/slug (e.g. FLUX, gemini-2.5-flash-image). |
transparent | bool | None | — | Mark the imported texture as alpha-is-transparency. NOTE: fal/FLUX and OpenRouter have no generation-time transparency, so this only sets the Unity import flag — it does not make the model render a transparent background. |
width | int | None | — | Output width in pixels. |
height | int | None | — | Output height in pixels. |
name | str | None | — | Base name for the imported asset. |
output_folder | str | None | — | Destination folder under Assets/ for the import. |
job_id | str | None | — | Job id for status/cancel. |
Returns
A dict containing the Unity response. The exact shape depends on the action.
Examples
No examples yet. Add usage examples here — they will be preserved across regenerations.