diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImage.g.cs index 1e2f994..e8d4984 100644 --- a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImage.g.cs @@ -22,7 +22,7 @@ partial void ProcessPostEditImageResponseContent( ref string content); /// - /// Edit
+ /// Edit (legacy)
/// Edit a given image synchronously using the provided mask. The mask indicates which part of the image
/// should be edited, while the prompt and chosen style type can further guide the edit.
/// Supported image formats include JPEG, PNG, and WebP.
@@ -304,7 +304,7 @@ partial void ProcessPostEditImageResponseContent( } /// - /// Edit
+ /// Edit (legacy)
/// Edit a given image synchronously using the provided mask. The mask indicates which part of the image
/// should be edited, while the prompt and chosen style type can further guide the edit.
/// Supported image formats include JPEG, PNG, and WebP.
diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImage.g.cs index c5ee8ef..fa38943 100644 --- a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImage.g.cs @@ -22,7 +22,7 @@ partial void ProcessPostGenerateImageResponseContent( ref string content); /// - /// Generate
+ /// Generate (legacy)
/// Generates images synchronously based on a given prompt and optional parameters.
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it. ///
@@ -268,25 +268,20 @@ partial void ProcessPostGenerateImageResponseContent( } /// - /// Generate
+ /// Generate (legacy)
/// Generates images synchronously based on a given prompt and optional parameters.
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it. ///
/// - /// - /// A list of base64 encoded binary embeddings. - /// /// The token to cancel the operation with /// public async global::System.Threading.Tasks.Task PostGenerateImageAsync( global::Ideogram.ImageRequest imageRequest, - global::System.Collections.Generic.IList? styleRefEmbeddings = default, global::System.Threading.CancellationToken cancellationToken = default) { var __request = new global::Ideogram.GenerateImageRequest { ImageRequest = imageRequest, - StyleRefEmbeddings = styleRefEmbeddings, }; return await PostGenerateImageAsync( diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImageV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImageV3.g.cs index 87da6d1..e009c59 100644 --- a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImageV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImageV3.g.cs @@ -378,7 +378,7 @@ partial void ProcessPostGenerateImageV3ResponseContent( /// /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReframeImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReframeImage.g.cs index 74a52d9..ae80779 100644 --- a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReframeImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReframeImage.g.cs @@ -22,7 +22,7 @@ partial void ProcessPostReframeImageResponseContent( ref string content); /// - /// Reframe
+ /// Reframe (legacy)
/// Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it. ///
@@ -292,7 +292,7 @@ partial void ProcessPostReframeImageResponseContent( } /// - /// Reframe
+ /// Reframe (legacy)
/// Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImage.g.cs index 80fb25b..4a13018 100644 --- a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImage.g.cs @@ -22,7 +22,7 @@ partial void ProcessPostRemixImageResponseContent( ref string content); /// - /// Remix
+ /// Remix (legacy)
/// Remix provided images synchronously based on a given prompt and optional parameters.
/// Input images are cropped to the chosen aspect ratio before being remixed.
/// Supported image formats include JPEG, PNG, and WebP.
@@ -273,7 +273,7 @@ partial void ProcessPostRemixImageResponseContent( } /// - /// Remix
+ /// Remix (legacy)
/// Remix provided images synchronously based on a given prompt and optional parameters.
/// Input images are cropped to the chosen aspect ratio before being remixed.
/// Supported image formats include JPEG, PNG, and WebP.
diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImageV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImageV3.g.cs index 13d961b..8844052 100644 --- a/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImageV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImageV3.g.cs @@ -402,7 +402,7 @@ partial void ProcessPostRemixImageV3ResponseContent( /// /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostEditImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostEditImage.g.cs index ec11d5e..f38b192 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostEditImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostEditImage.g.cs @@ -5,7 +5,7 @@ namespace Ideogram public partial interface IGenerateClient { /// - /// Edit
+ /// Edit (legacy)
/// Edit a given image synchronously using the provided mask. The mask indicates which part of the image
/// should be edited, while the prompt and chosen style type can further guide the edit.
/// Supported image formats include JPEG, PNG, and WebP.
@@ -19,7 +19,7 @@ public partial interface IGenerateClient global::System.Threading.CancellationToken cancellationToken = default); /// - /// Edit
+ /// Edit (legacy)
/// Edit a given image synchronously using the provided mask. The mask indicates which part of the image
/// should be edited, while the prompt and chosen style type can further guide the edit.
/// Supported image formats include JPEG, PNG, and WebP.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImage.g.cs index fb4051e..7150531 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImage.g.cs @@ -5,7 +5,7 @@ namespace Ideogram public partial interface IGenerateClient { /// - /// Generate
+ /// Generate (legacy)
/// Generates images synchronously based on a given prompt and optional parameters.
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it. ///
@@ -17,19 +17,15 @@ public partial interface IGenerateClient global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate
+ /// Generate (legacy)
/// Generates images synchronously based on a given prompt and optional parameters.
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it. ///
/// - /// - /// A list of base64 encoded binary embeddings. - /// /// The token to cancel the operation with /// global::System.Threading.Tasks.Task PostGenerateImageAsync( global::Ideogram.ImageRequest imageRequest, - global::System.Collections.Generic.IList? styleRefEmbeddings = default, global::System.Threading.CancellationToken cancellationToken = default); } } \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImageV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImageV3.g.cs index af58aa4..0b6a7b5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImageV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImageV3.g.cs @@ -62,7 +62,7 @@ public partial interface IGenerateClient /// /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostReframeImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostReframeImage.g.cs index ddce45b..f3522ee 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostReframeImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostReframeImage.g.cs @@ -5,7 +5,7 @@ namespace Ideogram public partial interface IGenerateClient { /// - /// Reframe
+ /// Reframe (legacy)
/// Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it. ///
@@ -17,7 +17,7 @@ public partial interface IGenerateClient global::System.Threading.CancellationToken cancellationToken = default); /// - /// Reframe
+ /// Reframe (legacy)
/// Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImage.g.cs index b0457a5..a656d50 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImage.g.cs @@ -5,7 +5,7 @@ namespace Ideogram public partial interface IGenerateClient { /// - /// Remix
+ /// Remix (legacy)
/// Remix provided images synchronously based on a given prompt and optional parameters.
/// Input images are cropped to the chosen aspect ratio before being remixed.
/// Supported image formats include JPEG, PNG, and WebP.
@@ -19,7 +19,7 @@ public partial interface IGenerateClient global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix
+ /// Remix (legacy)
/// Remix provided images synchronously based on a given prompt and optional parameters.
/// Input images are cropped to the chosen aspect ratio before being remixed.
/// Supported image formats include JPEG, PNG, and WebP.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImageV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImageV3.g.cs index bc05669..253adcd 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImageV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImageV3.g.cs @@ -76,7 +76,7 @@ public partial interface IGenerateClient /// /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequest.g.cs index 88cbf85..029175b 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequest.g.cs @@ -15,12 +15,6 @@ public sealed partial class GenerateImageRequest [global::System.Text.Json.Serialization.JsonRequired] public required global::Ideogram.ImageRequest ImageRequest { get; set; } - /// - /// A list of base64 encoded binary embeddings. - /// - [global::System.Text.Json.Serialization.JsonPropertyName("style_ref_embeddings")] - public global::System.Collections.Generic.IList? StyleRefEmbeddings { get; set; } - /// /// Additional properties that are not explicitly defined in the schema /// @@ -31,18 +25,13 @@ public sealed partial class GenerateImageRequest /// Initializes a new instance of the class. ///
/// - /// - /// A list of base64 encoded binary embeddings. - /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] #endif public GenerateImageRequest( - global::Ideogram.ImageRequest imageRequest, - global::System.Collections.Generic.IList? styleRefEmbeddings) + global::Ideogram.ImageRequest imageRequest) { this.ImageRequest = imageRequest ?? throw new global::System.ArgumentNullException(nameof(imageRequest)); - this.StyleRefEmbeddings = styleRefEmbeddings; } /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequestV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequestV3.g.cs index 6862a77..883b14e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequestV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequestV3.g.cs @@ -91,7 +91,7 @@ public sealed partial class GenerateImageRequestV3 /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL ///
/// GENERAL @@ -155,7 +155,7 @@ public sealed partial class GenerateImageRequestV3 /// /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ImageGenerationObjectV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ImageGenerationObjectV3.g.cs index 31231c6..6744d5a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ImageGenerationObjectV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ImageGenerationObjectV3.g.cs @@ -53,7 +53,7 @@ public sealed partial class ImageGenerationObjectV3 /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL ///
/// GENERAL @@ -91,7 +91,7 @@ public sealed partial class ImageGenerationObjectV3 /// /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL /// #if NET7_0_OR_GREATER diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageRequestV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageRequestV3.g.cs index 45468ba..bc2d938 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageRequestV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageRequestV3.g.cs @@ -113,7 +113,7 @@ public sealed partial class RemixImageRequestV3 /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL ///
/// GENERAL @@ -187,7 +187,7 @@ public sealed partial class RemixImageRequestV3 /// /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.StyleType.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.StyleType.g.cs index 7cb46ae..5300a3f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.StyleType.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.StyleType.g.cs @@ -33,6 +33,10 @@ public enum StyleType /// ///
ANIME, + /// + /// + /// + CUSTOM, } /// @@ -53,6 +57,7 @@ public static string ToValueString(this StyleType value) StyleType.DESIGN => "DESIGN", StyleType.RENDER3D => "RENDER_3D", StyleType.ANIME => "ANIME", + StyleType.CUSTOM => "CUSTOM", _ => throw new global::System.ArgumentOutOfRangeException(nameof(value), value, null), }; } @@ -69,6 +74,7 @@ public static string ToValueString(this StyleType value) "DESIGN" => StyleType.DESIGN, "RENDER_3D" => StyleType.RENDER3D, "ANIME" => StyleType.ANIME, + "CUSTOM" => StyleType.CUSTOM, _ => null, }; } diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.StyleTypeV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.StyleTypeV3.g.cs index 49f7c43..d6d444e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.StyleTypeV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.StyleTypeV3.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// The style type to generate with.
- /// Default Value: AUTO
+ /// Default Value: GENERAL
/// Example: GENERAL ///
public enum StyleTypeV3 diff --git a/src/libs/Ideogram/Generated/JsonSerializerContextTypes.g.cs b/src/libs/Ideogram/Generated/JsonSerializerContextTypes.g.cs index 2385b94..a7578df 100644 --- a/src/libs/Ideogram/Generated/JsonSerializerContextTypes.g.cs +++ b/src/libs/Ideogram/Generated/JsonSerializerContextTypes.g.cs @@ -118,23 +118,23 @@ public sealed partial class JsonSerializerContextTypes /// /// /// - public global::System.Collections.Generic.IList? Type23 { get; set; } + public global::Ideogram.GenerateImageRequestV3? Type23 { get; set; } /// /// /// - public global::Ideogram.GenerateImageRequestV3? Type24 { get; set; } + public global::Ideogram.ResolutionV3? Type24 { get; set; } /// /// /// - public global::Ideogram.ResolutionV3? Type25 { get; set; } + public global::Ideogram.AspectRatioV3? Type25 { get; set; } /// /// /// - public global::Ideogram.AspectRatioV3? Type26 { get; set; } + public global::Ideogram.RenderingSpeed? Type26 { get; set; } /// /// /// - public global::Ideogram.RenderingSpeed? Type27 { get; set; } + public global::System.Collections.Generic.IList? Type27 { get; set; } /// /// /// diff --git a/src/libs/Ideogram/openapi.yaml b/src/libs/Ideogram/openapi.yaml index 0f1aafb..0bdf50e 100644 --- a/src/libs/Ideogram/openapi.yaml +++ b/src/libs/Ideogram/openapi.yaml @@ -36,12 +36,16 @@ paths: $ref: '#/components/schemas/ImageSafetyError' '429': description: Too many requests. + x-fern-examples: + - code-samples: + - sdk: curl + code: "curl -X POST https://api.ideogram.ai/describe \\\n -H \"Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F image_file=@\n" x-openapi-router-controller: external_api.generated.openapi.controllers.vision_controller /edit: post: tags: - generate - summary: Edit + summary: Edit (legacy) description: "Edit a given image synchronously using the provided mask. The mask indicates which part of the image\nshould be edited, while the prompt and chosen style type can further guide the edit.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" operationId: post_edit_image requestBody: @@ -92,7 +96,7 @@ paths: post: tags: - generate - summary: Generate + summary: Generate (legacy) description: "Generates images synchronously based on a given prompt and optional parameters.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" operationId: post_generate_image requestBody: @@ -418,7 +422,7 @@ paths: post: tags: - generate - summary: Reframe + summary: Reframe (legacy) description: "Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.\n\nImage links are available for a limited period of time; if you would like to keep the image, you must download it.\n" operationId: post_reframe_image requestBody: @@ -453,7 +457,7 @@ paths: post: tags: - generate - summary: Remix + summary: Remix (legacy) description: "Remix provided images synchronously based on a given prompt and optional parameters.\n\nInput images are cropped to the chosen aspect ratio before being remixed.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" operationId: post_remix_image requestBody: @@ -524,6 +528,28 @@ paths: $ref: '#/components/schemas/GenerateImageSafetyError' '429': description: Too many requests. + x-fern-examples: + - request: + image_request: + resemblance: 55 + detail: 90 + response: + body: + created: '2000-01-23T04:56:07.0000000+00:00' + data: + - prompt: A photo of a cat + resolution: 1280x800 + is_image_safe: true + seed: 12345 + url: https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89 + style_type: GENERAL + code-samples: + - sdk: curl + code: "curl -X POST https://api.ideogram.ai/upscale \\\n -H \"Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F image_file=@ \\\n -F image_request='{\n \"resemblance\": 55,\n \"detail\": 90\n }'\n" + - sdk: python + code: "import requests\n\nresponse = requests.post(\n \"https://api.ideogram.ai/upscale\",\n headers={\n \"Api-Key\": \"\"\n },\n data={\n \"image_request\": {\n \"resemblance\": 55,\n \"detail\": 90\n }\n },\n files={\n \"image_file\": open(\"\", \"rb\")\n }\n)\nprint(response.json())\nwith open('output.png', 'wb') as f:\n f.write(requests.get(response.json()['data'][0]['url']).content)\n" + - sdk: typescript + code: "const formData = new FormData();\nformData.append('image_request', JSON.stringify({\n resemblance: 55,\n detail: 90\n}));\nformData.append('image_file', new Blob([fs.readFileSync(\"\")], {\n type: 'image/png'\n}));\nconst response = await fetch('https://api.ideogram.ai/upscale', {\n method: 'POST',\n headers: { 'Api-Key': '' },\n body: formData\n});\nconst data = await response.json();\nconsole.log(data);\n" x-openapi-router-controller: external_api.generated.openapi.controllers.generate_controller /v1/ideogram-v3/edit: post: @@ -563,6 +589,26 @@ paths: $ref: '#/components/schemas/GenerateImageSafetyError' '429': description: Too many requests. + x-fern-examples: + - request: + prompt: A photo of a cat wearing a hat. + response: + body: + created: '2000-01-23T04:56:07.0000000+00:00' + data: + - prompt: A photo of a cat wearing a hat. + resolution: 1024x1024 + is_image_safe: true + seed: 12345 + url: https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89 + style_type: GENERAL + code-samples: + - sdk: curl + code: "curl -X POST https://api.ideogram.ai/v1/ideogram-v3/edit \\\n -H \"Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F image=@ \\\n -F mask=@ \\\n -F prompt=\"A photo of a cat wearing a hat.\" \\\n -F rendering_speed=\"DEFAULT\"\n" + - sdk: python + code: "import requests\n\nresponse = requests.post(\n \"https://api.ideogram.ai/v1/ideogram-v3/edit\",\n headers={\n \"Api-Key\": \"\"\n },\n data={\n \"prompt\": \"A photo of a cat wearing a hat.\",\n \"rendering_speed\": \"DEFAULT\"\n },\n files={\n \"image\": open(\"\", \"rb\"),\n \"mask\": open(\"\", \"rb\"),\n }\n)\nprint(response.json())\nwith open('output.png', 'wb') as f:\n f.write(requests.get(response.json()['data'][0]['url']).content)\n" + - sdk: typescript + code: "const formData = new FormData();\nformData.append('prompt', 'A photo of a cat');\nformData.append('rendering_speed', 'TURBO');\nconst response = await fetch('https://api.ideogram.ai/v1/ideogram-v3/edit', {\n method: 'POST',\n headers: { 'Api-Key': '' },\n body: formData\n});\nconst data = await response.json();\nconsole.log(data);\n" x-openapi-router-controller: external_api.generated.openapi.controllers.generate_controller /v1/ideogram-v3/generate: post: @@ -605,6 +651,28 @@ paths: $ref: '#/components/schemas/GenerateImageSafetyError' '429': description: Too many requests. + x-fern-examples: + - request: + prompt: A photo of a cat sleeping on a couch. + rendering_speed: TURBO + aspect_ratio: 1x1 + response: + body: + created: '2000-01-23T04:56:07.0000000+00:00' + data: + - prompt: A photo of a cat sleeping on a couch. + resolution: 1024x1024 + is_image_safe: true + seed: 12345 + url: https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89 + style_type: GENERAL + code-samples: + - sdk: curl + code: "curl -X POST https://api.ideogram.ai/v1/ideogram-v3/generate \\\n -H \"Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F prompt=\"A photo of a cat sleeping on a couch.\" \\\n -F rendering_speed=\"TURBO\"\n" + - sdk: python + code: "import requests\n\n# Generate with Ideogram 3.0 (POST /v1/ideogram-v3/generate)\nresponse = requests.post(\n \"https://api.ideogram.ai/v1/ideogram-v3/generate\",\n headers={\n \"Api-Key\": \"\"\n },\n json={\n \"prompt\": \"A picture of a cat\",\n \"rendering_speed\": \"TURBO\"\n }\n)\nprint(response.json())\nwith open('output.png', 'wb') as f:\n f.write(requests.get(response.json()['data'][0]['url']).content)\n\n# Generate with style reference images\nresponse = requests.post(\n \"https://api.ideogram.ai/v1/ideogram-v3/generate\",\n headers={\n \"Api-Key\": \"\"\n },\n data={\n \"prompt\": \"A picture of a cat\",\n \"aspect_ratio\": \"3x1\"\n },\n files=[\n (\"style_reference_images\", open(\"style_reference_image_1.png\", \"rb\")),\n (\"style_reference_images\", open(\"style_reference_image_2.png\", \"rb\")),\n ]\n)\nprint(response.json())\nwith open('output.png', 'wb') as f:\n f.write(requests.get(response.json()['data'][0]['url']).content)\n" + - sdk: typescript + code: "const formData = new FormData();\nformData.append('prompt', 'A photo of a cat');\nformData.append('rendering_speed', 'TURBO');\n// To add style reference images, uncomment the following lines\n// formData.append('style_reference_images', '');\n// formData.append('style_reference_images', '');\nconst response = await fetch('https://api.ideogram.ai/v1/ideogram-v3/generate', {\n method: 'POST',\n headers: { 'Api-Key': '' },\n body: formData\n});\nconst data = await response.json();\nconsole.log(data);\n" x-openapi-router-controller: external_api.generated.openapi.controllers.generate_controller /v1/ideogram-v3/reframe: post: @@ -644,6 +712,26 @@ paths: $ref: '#/components/schemas/GenerateImageSafetyError' '429': description: Too many requests. + x-fern-examples: + - request: + resolution: 512x1536 + response: + body: + created: '2000-01-23T04:56:07.0000000+00:00' + data: + - prompt: A photo of a cat + resolution: 1280x800 + is_image_safe: true + seed: 12345 + url: https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89 + style_type: GENERAL + code-samples: + - sdk: curl + code: "curl -X POST https://api.ideogram.ai/v1/ideogram-v3/reframe \\\n -H \"Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F image=@ \\\n -F resolution=\"512x1536\"\n" + - sdk: python + code: "import requests\n\nresponse = requests.post(\n \"https://api.ideogram.ai/v1/ideogram-v3/reframe\",\n headers={\n \"Api-Key\": \"\"\n },\n data={\n \"resolution\": \"512x1536\"\n },\n files={\n \"image\": open(\"\", \"rb\"),\n }\n)\nprint(response.json())\nwith open('output.png', 'wb') as f:\n f.write(requests.get(response.json()['data'][0]['url']).content)\n" + - sdk: typescript + code: "const formData = new FormData();\nformData.append('resolution', '512x1536');\nformData.append('image', '');\nconst response = await fetch('https://api.ideogram.ai/v1/ideogram-v3/reframe', {\n method: 'POST',\n headers: { 'Api-Key': '' },\n body: formData\n});\nconst data = await response.json();\nconsole.log(data);\n" x-openapi-router-controller: external_api.generated.openapi.controllers.generate_controller /v1/ideogram-v3/remix: post: @@ -683,6 +771,29 @@ paths: $ref: '#/components/schemas/GenerateImageSafetyError' '429': description: Too many requests. + x-fern-examples: + - request: + prompt: A photo of a cat + rendering_speed: DEFAULT + image_weight: 50 + aspect_ratio: 1x2 + response: + body: + created: '2000-01-23T04:56:07.0000000+00:00' + data: + - prompt: A photo of a cat + resolution: 1280x800 + is_image_safe: true + seed: 12345 + url: https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89 + style_type: GENERAL + code-samples: + - sdk: curl + code: "curl -X POST https://api.ideogram.ai/v1/ideogram-v3/remix \\\n -H \"Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F image=@ \\\n -F prompt=\"A photo of a cat\" \\\n -F rendering_speed=\"TURBO\"\n" + - sdk: python + code: "import requests\n\nresponse = requests.post(\n \"https://api.ideogram.ai/v1/ideogram-v3/remix\",\n headers={\n \"Api-Key\": \"\"\n },\n data={\n \"prompt\": \"A photo of a cat\",\n \"rendering_speed\": \"TURBO\"\n },\n files={\n \"image\": open(\"\", \"rb\"),\n }\n)\nprint(response.json())\nwith open('output.png', 'wb') as f:\n f.write(requests.get(response.json()['data'][0]['url']).content)\n" + - sdk: typescript + code: "const formData = new FormData();\nformData.append('prompt', 'A photo of a cat');\nformData.append('rendering_speed', 'TURBO');\nformData.append('image', '');\nconst response = await fetch('https://api.ideogram.ai/v1/ideogram-v3/remix', {\n method: 'POST',\n headers: { 'Api-Key': '' },\n body: formData\n});\nconst data = await response.json();\nconsole.log(data);\n" x-openapi-router-controller: external_api.generated.openapi.controllers.generate_controller /v1/ideogram-v3/replace-background: post: @@ -722,6 +833,28 @@ paths: $ref: '#/components/schemas/GenerateImageSafetyError' '429': description: Too many requests. + x-fern-examples: + - request: + prompt: Add a forest in the background + magic_prompt: ON + rendering_speed: QUALITY + response: + body: + created: '2000-01-23T04:56:07.0000000+00:00' + data: + - prompt: Add a forest in the background + resolution: 1280x800 + is_image_safe: true + seed: 12345 + url: https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89 + style_type: GENERAL + code-samples: + - sdk: curl + code: "curl -X POST https://api.ideogram.ai/v1/ideogram-v3/replace-background \\\n -H \"Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F image=@ \\\n -F prompt=\"Add a forest in the background\"\n" + - sdk: python + code: "import requests\n\nresponse = requests.post(\n \"https://api.ideogram.ai/v1/ideogram-v3/replace-background\",\n headers={\n \"Api-Key\": \"\" \n },\n data={\n \"prompt\": \"Add a forest in the background\",\n \"magic_prompt\": \"ON\"\n },\n files={\n \"image\": open(\"\", \"rb\"),\n }\n)\nprint(response.json())\nwith open('output.png', 'wb') as f:\n f.write(requests.get(response.json()['data'][0]['url']).content)\n" + - sdk: typescript + code: "const formData = new FormData();\nformData.append('prompt', 'Add a forest in the background');\nformData.append('image', '');\nconst response = await fetch('https://api.ideogram.ai/v1/ideogram-v3/replace-background', {\n method: 'POST',\n headers: { 'Api-Key': '' },\n body: formData\n});\nconst data = await response.json();\nconsole.log(data);\n" x-openapi-router-controller: external_api.generated.openapi.controllers.generate_controller components: schemas: @@ -787,16 +920,7 @@ components: properties: image_request: $ref: '#/components/schemas/ImageRequest' - style_ref_embeddings: - title: style_ref_embeddings - type: array - items: - type: string - description: A list of base64 encoded binary embeddings. example: - style_ref_embeddings: - - style_ref_embeddings - - style_ref_embeddings image_request: aspect_ratio: ASPECT_10_16 magic_prompt_option: AUTO @@ -1809,6 +1933,7 @@ components: - DESIGN - RENDER_3D - ANIME + - CUSTOM type: string description: The style type to generate with; this is only applicable for models V_2 and above and should not be specified for model versions V_1. example: REALISTIC @@ -2043,7 +2168,7 @@ components: - DESIGN type: string description: The style type to generate with. - default: AUTO + default: GENERAL example: GENERAL Resolution: title: Resolution