GET
/v1/schemas/fal/image/fal-ai/ideogram/character/edit
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above. upstream-spec Source traceb54f253d09bd43bc5cb9190a15efeeaecde28a9c3f17826ce502b018fbb67014{
"fetchedAt": 1793250001,
"extractorVersion": "1",
"verifiedAt": null
} |
Request body
14 properties · 4 required · 3 $defs| property | type | description | constraints |
|---|---|---|---|
| mask_url* | string | The mask URL to inpaint the image. MUST have the exact same dimensions (width and height) as the input image. | |
| prompt* | string | The prompt to fill the masked part of the image. | |
| image_url* | string | The image URL to generate an image from. MUST have the exact same dimensions (width and height) as the mask image. | |
| reference_image_urls* | string[] | A set of images to use as character references. Currently only 1 image is supported, rest will be ignored. (maximum total size 10MB across all character references). The images should be in JPEG, PNG or WebP format | |
| image_urls | string[] | A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format | nullable |
| seed | integer | Seed for the random number generator | nullable |
| enable_safety_checker | boolean | Authorized callers may set false to request relaxed screening. | default: true |
| style_codes | string[] | A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style | nullable |
| num_images | integer | Number of images to generate. | 1 ≤ n ≤ 8 · default: 1 |
| sync_mode | boolean | If `True`, the media will be returned as a data URI and the output data won't be available in the request history. | default: false |
| reference_mask_urls | string[] | A set of masks to apply to the character references. Currently only 1 mask is supported, rest will be ignored. (maximum total size 10MB across all character references). The masks should be in JPEG, PNG or WebP format | |
| rendering_speed | enum | The rendering speed to use. | TURBO | BALANCED | QUALITY · default: "BALANCED" |
| color_palette | ColorPalette | A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members) | nullable |
| enable_prompt_expansion | boolean | Determine if MagicPrompt should be used in generating the request or not. | default: true |
Types
3 $defsColorPaletteobject
| members | ColorPaletteMember[] | A list of color palette members that define the color palette | nullable |
| name | enum | A color palette preset value | EMBER | FRESH | JUNGLE | MAGIC | MELON | MOSAIC · +2 more · nullable |
ColorPaletteMemberobject
| color_weight | number | The weight of the color in the color palette | 0.05 ≤ n ≤ 1 · nullable |
| rgb* | RGBColor | RGB color value for the palette member |
RGBColorobject
| b | integer | Blue color value | 0 ≤ n ≤ 255 · default: 0 |
| g | integer | Green color value | 0 ≤ n ≤ 255 · default: 0 |
| r | integer | Red color value | 0 ≤ n ≤ 255 · default: 0 |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"fal","endpointId":"fal-ai/ideogram/character/edit","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}