You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// Edit one or more images using a text prompt. Provide images via file upload<br/>
28
+
/// or Ideogram image URLs, and describe the desired edit in your prompt.<br/>
29
+
/// Unlike inpainting (/v1/ideogram-v3/inpaint), no mask is required. The model interprets the<br/>
30
+
/// prompt to determine what to change.<br/>
31
+
/// Supported image formats include JPEG, PNG, and WebP.<br/>
32
+
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
33
+
/// </summary>
34
+
/// <param name="prompt">
35
+
/// The prompt describing the desired edit.<br/>
36
+
/// Example: Change the background to a beach sunset.
37
+
/// </param>
38
+
/// <param name="images">
39
+
/// Images to edit (max 10 images, max size 10MB each); JPEG, WebP and PNG formats are supported.
40
+
/// </param>
41
+
/// <param name="imageUrls">
42
+
/// URLs to Ideogram images to use as references (max 10). Supports URLs from generation responses and image uploads. Alternative to uploading via the images field.
43
+
/// </param>
44
+
/// <param name="numImages">
45
+
/// The number of images to generate.<br/>
46
+
/// Default Value: 1
47
+
/// </param>
48
+
/// <param name="seed">
49
+
/// Random seed. Set for reproducible generation.<br/>
50
+
/// Example: 12345
51
+
/// </param>
52
+
/// <param name="magicPrompt">
53
+
/// Determine if MagicPrompt should be used in generating the request or not.<br/>
54
+
/// Example: ON
55
+
/// </param>
56
+
/// <param name="resolution">
57
+
/// The resolutions supported for Ideogram 3.0.<br/>
58
+
/// Example: 1280x800
59
+
/// </param>
60
+
/// <param name="aspectRatio">
61
+
/// The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1x1.
62
+
/// </param>
63
+
/// <param name="transparentBackground">
64
+
/// Whether the output should have a transparent background. Default false.<br/>
65
+
/// Default Value: false
66
+
/// </param>
67
+
/// <param name="requestOptions">Per-request overrides such as headers, query parameters, timeout, retries, and response buffering.</param>
68
+
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// Inpaint a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of the image<br/>
26
+
/// should be edited, while the prompt and chosen style can further guide the edit.<br/>
27
+
/// Supported image formats include JPEG, PNG, and WebP.<br/>
28
+
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
29
+
/// </summary>
30
+
/// <param name="image">
31
+
/// The image being edited (max size 10MB); only JPEG, WebP and PNG formats are supported at this time.
32
+
/// </param>
33
+
/// <param name="imagename">
34
+
/// The image being edited (max size 10MB); only JPEG, WebP and PNG formats are supported at this time.
35
+
/// </param>
36
+
/// <param name="mask">
37
+
/// A black and white image of the same size as the image being edited (max size 10MB). Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time.
38
+
/// </param>
39
+
/// <param name="maskname">
40
+
/// A black and white image of the same size as the image being edited (max size 10MB). Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time.
41
+
/// </param>
42
+
/// <param name="prompt">
43
+
/// The prompt used to describe the edited result.<br/>
44
+
/// Example: A photo of a cat.
45
+
/// </param>
46
+
/// <param name="magicPrompt">
47
+
/// Determine if MagicPrompt should be used in generating the request or not.<br/>
48
+
/// Example: ON
49
+
/// </param>
50
+
/// <param name="numImages">
51
+
/// The number of images to generate.<br/>
52
+
/// Default Value: 1
53
+
/// </param>
54
+
/// <param name="seed">
55
+
/// Random seed. Set for reproducible generation.<br/>
56
+
/// Example: 12345
57
+
/// </param>
58
+
/// <param name="renderingSpeed">
59
+
/// The rendering speed to use.<br/>
60
+
/// Default Value: DEFAULT
61
+
/// </param>
62
+
/// <param name="styleType">
63
+
/// The style type to generate with.<br/>
64
+
/// Default Value: GENERAL<br/>
65
+
/// Example: GENERAL
66
+
/// </param>
67
+
/// <param name="stylePreset">
68
+
/// A predefined style preset that applies a specific artistic style to the generated image.<br/>
69
+
/// Example: BRIGHT_ART
70
+
/// </param>
71
+
/// <param name="customModelUri">
72
+
/// A custom model URI in the format model/<model_name>/version/<version_name>. <br/>
73
+
/// When provided, the model version and style will be resolved from this URI, and style_type is not required.<br/>
74
+
/// Example: model/my-custom-model/version/1
75
+
/// </param>
76
+
/// <param name="colorPalette">
77
+
/// 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). Not supported by V_1, V_1_TURBO, V_2A and V_2A_TURBO models.
78
+
/// </param>
79
+
/// <param name="styleCodes">
80
+
/// A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type.<br/>
81
+
/// Example: [AAFF5733, 0133FF57, DE3357FF]
82
+
/// </param>
83
+
/// <param name="styleReferenceImages">
84
+
/// 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.
85
+
/// </param>
86
+
/// <param name="characterReferenceImages">
87
+
/// Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format.
88
+
/// </param>
89
+
/// <param name="characterReferenceImagesMask">
90
+
/// Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format.
91
+
/// </param>
92
+
/// <param name="requestOptions">Per-request overrides such as headers, query parameters, timeout, retries, and response buffering.</param>
93
+
/// <param name="cancellationToken">The token to cancel the operation with</param>
![github-actions[bot]](https://github.githubassets.com/images/gravatars/gravatar-user-420.png?size=40){kind=avatar}
0 commit comments