falaw.operations.images

Image-generation and image-manipulation operations.

Functions

composite_character_in_environment(...[, ...])	Place a character into an environment as one composited still.
edit_image(image_url, prompt, *[, quality, ...])	Edit an image with a natural-language instruction.
generate_image(prompt, *[, quality, ...])	Generate an image from a text prompt.
generate_image_with_refs(prompt, ...[, ...])	Generate a new image conditioned on one or more reference images.
remove_background(image_url, *[, quality, ...])	Remove the background from an image.
upscale_image(image_url, *[, scale, ...])	Upscale an image.

falaw.operations.images.composite_character_in_environment(character_image_url, environment_image_url, *, prompt='', quality='balanced', model_id=None, extra=None)

Place a character into an environment as one composited still.

The single most user-visible primitive missing from muvid (per interface_design_plan item E). With this, an agent can produce “Thor in a bell tower” — the character anchor for a downstream omnihuman lipsync — without manually compositing in an image editor.

Defaults to fal-ai/flux-kontext/dev (image_edit category at balanced/high tier). Pass model_id to override (e.g. "fal-ai/flux-pro/kontext/max" for highest quality, or "fal-ai/bytedance/seededit/v3/edit-image" for SeedEdit).

Return type:

Result

falaw.operations.images.edit_image(image_url, prompt, *, quality='balanced', model_id=None, extra=None)

Edit an image with a natural-language instruction.

Return type:

Result

falaw.operations.images.generate_image(prompt, *, quality='balanced', image_size='landscape_4_3', model_id=None, extra=None)

Generate an image from a text prompt.

image_size is a fal preset (landscape_16_9 …); models that size by aspect_ratio (nano-banana-pro) get the equivalent ratio, with extra={"resolution": "2K"} for the pixel tier. A prompt over the model’s cap raises falaw.FalPromptTooLong before any call. Check falaw.model_params() for enums whose default may not be what you want (Recraft style defaults to photoreal).

Return type:

Result

falaw.operations.images.generate_image_with_refs(prompt, reference_image_urls, *, quality='balanced', model_id=None, extra=None)

Generate a new image conditioned on one or more reference images.

The missing twin of generate_image(): text-to-image models silently ignore reference images, so callers wanting a recurring subject to stay consistent (a character’s face across storyboard panels) need a model that actually ingests references. This routes to the image_edit category (Flux Kontext et al.) and threads the references as image_url (first)

• image_urls (all) — the same wire shape image-edit models understand.

Pass model_id to override the picked model.

Return type:

Result

falaw.operations.images.remove_background(image_url, *, quality='high', model_id=None, extra=None)

Remove the background from an image.

Return type:

Result

falaw.operations.images.upscale_image(image_url, *, scale=2.0, model_id=None, extra=None)

Upscale an image.

Return type:

Result